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 DBIx::Class::Exception;
12 use Scalar::Util qw/refaddr weaken reftype blessed/;
13 use List::Util qw/first/;
14 use Sub::Name 'subname';
15 use Context::Preserve 'preserve_context';
18 use Data::Compare (); # no imports!!! guard against insane architecture
19 use DBI::Const::GetInfoType (); # no import of retarded global hash
22 # default cursor class, overridable in connect_info attributes
23 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
25 __PACKAGE__->mk_group_accessors('inherited' => qw/
26 sql_limit_dialect sql_quote_char sql_name_sep
29 __PACKAGE__->mk_group_accessors('component_class' => qw/sql_maker_class datetime_parser_type/);
31 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
32 __PACKAGE__->datetime_parser_type('DateTime::Format::MySQL'); # historic default
34 __PACKAGE__->sql_name_sep('.');
36 __PACKAGE__->mk_group_accessors('simple' => qw/
37 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
38 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts _dbh_autocommit
39 _perform_autoinc_retrieval _autoinc_supplied_for_op
42 # the values for these accessors are picked out (and deleted) from
43 # the attribute hashref passed to connect_info
44 my @storage_options = qw/
45 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
46 disable_sth_caching unsafe auto_savepoint
48 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
51 # capability definitions, using a 2-tiered accessor system
54 # A driver/user may define _use_X, which blindly without any checks says:
55 # "(do not) use this capability", (use_dbms_capability is an "inherited"
58 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
59 # accessor, which in turn calls _determine_supports_X, and stores the return
60 # in a special slot on the storage object, which is wiped every time a $dbh
61 # reconnection takes place (it is not guaranteed that upon reconnection we
62 # will get the same rdbms version). _determine_supports_X does not need to
63 # exist on a driver, as we ->can for it before calling.
65 my @capabilities = (qw/
67 insert_returning_bound
76 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
77 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
79 # on by default, not strictly a capability (pending rewrite)
80 __PACKAGE__->_use_join_optimizer (1);
81 sub _determine_supports_join_optimizer { 1 };
83 # Each of these methods need _determine_driver called before itself
84 # in order to function reliably. This is a purely DRY optimization
86 # get_(use)_dbms_capability need to be called on the correct Storage
87 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
88 # _determine_supports_X which obv. needs a correct driver as well
89 my @rdbms_specific_methods = qw/
103 with_deferred_fk_checks
105 get_use_dbms_capability
112 for my $meth (@rdbms_specific_methods) {
114 my $orig = __PACKAGE__->can ($meth)
115 or die "$meth is not a ::Storage::DBI method!";
118 no warnings qw/redefine/;
119 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
121 # only fire when invoked on an instance, a valid class-based invocation
122 # would e.g. be setting a default for an inherited accessor
125 ! $_[0]->_driver_determined
127 ! $_[0]->{_in_determine_driver}
129 $_[0]->_determine_driver;
131 # This for some reason crashes and burns on perl 5.8.1
132 # IFF the method ends up throwing an exception
133 #goto $_[0]->can ($meth);
135 my $cref = $_[0]->can ($meth);
145 DBIx::Class::Storage::DBI - DBI storage handler
149 my $schema = MySchema->connect('dbi:SQLite:my.db');
151 $schema->storage->debug(1);
153 my @stuff = $schema->storage->dbh_do(
155 my ($storage, $dbh, @args) = @_;
156 $dbh->do("DROP TABLE authors");
161 $schema->resultset('Book')->search({
162 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
167 This class represents the connection to an RDBMS via L<DBI>. See
168 L<DBIx::Class::Storage> for general information. This pod only
169 documents DBI-specific methods and behaviors.
176 my $new = shift->next::method(@_);
178 $new->_sql_maker_opts({});
179 $new->_dbh_details({});
180 $new->{_in_do_block} = 0;
181 $new->{_dbh_gen} = 0;
183 # read below to see what this does
184 $new->_arm_global_destructor;
189 # This is hack to work around perl shooting stuff in random
190 # order on exit(). If we do not walk the remaining storage
191 # objects in an END block, there is a *small but real* chance
192 # of a fork()ed child to kill the parent's shared DBI handle,
193 # *before perl reaches the DESTROY in this package*
194 # Yes, it is ugly and effective.
195 # Additionally this registry is used by the CLONE method to
196 # make sure no handles are shared between threads
198 my %seek_and_destroy;
200 sub _arm_global_destructor {
202 my $key = refaddr ($self);
203 $seek_and_destroy{$key} = $self;
204 weaken ($seek_and_destroy{$key});
208 local $?; # just in case the DBI destructor changes it somehow
210 # destroy just the object if not native to this process
211 $_->_verify_pid for (grep
213 values %seek_and_destroy
218 # As per DBI's recommendation, DBIC disconnects all handles as
219 # soon as possible (DBIC will reconnect only on demand from within
221 for (values %seek_and_destroy) {
223 $_->{_dbh_gen}++; # so that existing cursors will drop as well
226 $_->transaction_depth(0);
235 # some databases spew warnings on implicit disconnect
236 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
237 local $SIG{__WARN__} = sub {};
240 # this op is necessary, since the very last perl runtime statement
241 # triggers a global destruction shootout, and the $SIG localization
242 # may very well be destroyed before perl actually gets to do the
247 # handle pid changes correctly - do not destroy parent's connection
251 my $pid = $self->_conn_pid;
252 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
253 $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;
797 DBIx::Class::Storage::BlockRunner->new(
799 run_code => sub { $self->$run_target ($self->_get_dbh, @$args ) },
801 retry_handler => sub { ! ( $_[0]->retried_count or $_[0]->storage->connected ) },
806 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
807 shift->next::method(@_);
812 Our C<disconnect> method also performs a rollback first if the
813 database is not in C<AutoCommit> mode.
823 push @actions, ( $self->on_disconnect_call || () );
824 push @actions, $self->_parse_connect_do ('on_disconnect_do');
826 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
828 # stops the "implicit rollback on disconnect" warning
829 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
831 %{ $self->_dbh->{CachedKids} } = ();
832 $self->_dbh->disconnect;
838 =head2 with_deferred_fk_checks
842 =item Arguments: C<$coderef>
844 =item Return Value: The return value of $coderef
848 Storage specific method to run the code ref with FK checks deferred or
849 in MySQL's case disabled entirely.
853 # Storage subclasses should override this
854 sub with_deferred_fk_checks {
855 my ($self, $sub) = @_;
863 =item Arguments: none
865 =item Return Value: 1|0
869 Verifies that the current database handle is active and ready to execute
870 an SQL statement (e.g. the connection did not get stale, server is still
871 answering, etc.) This method is used internally by L</dbh>.
877 return 0 unless $self->_seems_connected;
880 local $self->_dbh->{RaiseError} = 1;
885 sub _seems_connected {
888 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
890 my $dbh = $self->_dbh
893 return $dbh->FETCH('Active');
899 my $dbh = $self->_dbh or return 0;
904 sub ensure_connected {
907 unless ($self->connected) {
908 $self->_populate_dbh;
914 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
915 is guaranteed to be healthy by implicitly calling L</connected>, and if
916 necessary performing a reconnection before returning. Keep in mind that this
917 is very B<expensive> on some database engines. Consider using L</dbh_do>
925 if (not $self->_dbh) {
926 $self->_populate_dbh;
928 $self->ensure_connected;
933 # this is the internal "get dbh or connect (don't check)" method
936 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
937 $self->_populate_dbh unless $self->_dbh;
943 unless ($self->_sql_maker) {
944 my $sql_maker_class = $self->sql_maker_class;
946 my %opts = %{$self->_sql_maker_opts||{}};
950 $self->sql_limit_dialect
953 my $s_class = (ref $self) || $self;
955 "Your storage class ($s_class) does not set sql_limit_dialect and you "
956 . 'have not supplied an explicit limit_dialect in your connection_info. '
957 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
958 . 'databases but can be (and often is) painfully slow. '
959 . "Please file an RT ticket against '$s_class' ."
966 my ($quote_char, $name_sep);
968 if ($opts{quote_names}) {
969 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
970 my $s_class = (ref $self) || $self;
972 "You requested 'quote_names' but your storage class ($s_class) does "
973 . 'not explicitly define a default sql_quote_char and you have not '
974 . 'supplied a quote_char as part of your connection_info. DBIC will '
975 .q{default to the ANSI SQL standard quote '"', which works most of }
976 . "the time. Please file an RT ticket against '$s_class'."
982 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
985 $self->_sql_maker($sql_maker_class->new(
987 array_datatypes => 1,
988 limit_dialect => $dialect,
989 ($quote_char ? (quote_char => $quote_char) : ()),
990 name_sep => ($name_sep || '.'),
994 return $self->_sql_maker;
997 # nothing to do by default
1004 my @info = @{$self->_dbi_connect_info || []};
1005 $self->_dbh(undef); # in case ->connected failed we might get sent here
1006 $self->_dbh_details({}); # reset everything we know
1008 $self->_dbh($self->_connect(@info));
1010 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1012 $self->_determine_driver;
1014 # Always set the transaction depth on connect, since
1015 # there is no transaction in progress by definition
1016 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1018 $self->_run_connection_actions unless $self->{_in_determine_driver};
1021 sub _run_connection_actions {
1025 push @actions, ( $self->on_connect_call || () );
1026 push @actions, $self->_parse_connect_do ('on_connect_do');
1028 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1033 sub set_use_dbms_capability {
1034 $_[0]->set_inherited ($_[1], $_[2]);
1037 sub get_use_dbms_capability {
1038 my ($self, $capname) = @_;
1040 my $use = $self->get_inherited ($capname);
1043 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1047 sub set_dbms_capability {
1048 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1051 sub get_dbms_capability {
1052 my ($self, $capname) = @_;
1054 my $cap = $self->_dbh_details->{capability}{$capname};
1056 unless (defined $cap) {
1057 if (my $meth = $self->can ("_determine$capname")) {
1058 $cap = $self->$meth ? 1 : 0;
1064 $self->set_dbms_capability ($capname, $cap);
1074 unless ($info = $self->_dbh_details->{info}) {
1080 $server_version = $self->_get_server_version;
1083 if ($self->{_in_determine_driver}) {
1084 $self->throw_exception($_);
1086 $server_version = undef;
1089 if (defined $server_version) {
1090 $info->{dbms_version} = $server_version;
1092 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1093 my @verparts = split (/\./, $numeric_version);
1099 # consider only up to 3 version parts, iff not more than 3 digits
1101 while (@verparts && @use_parts < 3) {
1102 my $p = shift @verparts;
1104 push @use_parts, $p;
1106 push @use_parts, 0 while @use_parts < 3;
1108 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1112 $self->_dbh_details->{info} = $info;
1118 sub _get_server_version {
1119 shift->_dbh_get_info('SQL_DBMS_VER');
1123 my ($self, $info) = @_;
1125 if ($info =~ /[^0-9]/) {
1126 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1127 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1128 unless defined $info;
1134 $res = $self->_get_dbh->get_info($info);
1137 if ($self->{_in_determine_driver}) {
1138 $self->throw_exception($_);
1146 sub _describe_connection {
1147 require DBI::Const::GetInfoReturn;
1150 $self->ensure_connected;
1153 DBIC_DSN => $self->_dbi_connect_info->[0],
1154 DBI_VER => DBI->VERSION,
1155 DBIC_VER => DBIx::Class->VERSION,
1156 DBIC_DRIVER => ref $self,
1160 #keys %DBI::Const::GetInfoType::GetInfoType,
1162 SQL_CURSOR_COMMIT_BEHAVIOR
1163 SQL_CURSOR_ROLLBACK_BEHAVIOR
1164 SQL_CURSOR_SENSITIVITY
1165 SQL_DATA_SOURCE_NAME
1168 SQL_DEFAULT_TXN_ISOLATION
1173 SQL_EXPRESSIONS_IN_ORDERBY
1176 SQL_IDENTIFIER_QUOTE_CHAR
1177 SQL_MAX_CATALOG_NAME_LEN
1178 SQL_MAX_COLUMN_NAME_LEN
1179 SQL_MAX_IDENTIFIER_LEN
1180 SQL_MAX_TABLE_NAME_LEN
1181 SQL_MULTIPLE_ACTIVE_TXN
1182 SQL_MULT_RESULT_SETS
1183 SQL_NEED_LONG_DATA_LEN
1184 SQL_NON_NULLABLE_COLUMNS
1186 SQL_QUALIFIER_NAME_SEPARATOR
1187 SQL_QUOTED_IDENTIFIER_CASE
1189 SQL_TXN_ISOLATION_OPTION
1192 my $v = $self->_dbh_get_info($inf);
1193 next unless defined $v;
1195 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1196 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1197 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1203 sub _determine_driver {
1206 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1207 my $started_connected = 0;
1208 local $self->{_in_determine_driver} = 1;
1210 if (ref($self) eq __PACKAGE__) {
1212 if ($self->_dbh) { # we are connected
1213 $driver = $self->_dbh->{Driver}{Name};
1214 $started_connected = 1;
1217 # if connect_info is a CODEREF, we have no choice but to connect
1218 if (ref $self->_dbi_connect_info->[0] &&
1219 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1220 $self->_populate_dbh;
1221 $driver = $self->_dbh->{Driver}{Name};
1224 # try to use dsn to not require being connected, the driver may still
1225 # force a connection in _rebless to determine version
1226 # (dsn may not be supplied at all if all we do is make a mock-schema)
1227 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1228 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1229 $driver ||= $ENV{DBI_DRIVER};
1234 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1235 if ($self->load_optional_class($storage_class)) {
1236 mro::set_mro($storage_class, 'c3');
1237 bless $self, $storage_class;
1241 $self->_warn_undetermined_driver(
1242 'This version of DBIC does not yet seem to supply a driver for '
1243 . "your particular RDBMS and/or connection method ('$driver')."
1248 $self->_warn_undetermined_driver(
1249 'Unable to extract a driver name from connect info - this '
1250 . 'should not have happened.'
1255 $self->_driver_determined(1);
1257 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1259 $self->_init; # run driver-specific initializations
1261 $self->_run_connection_actions
1262 if !$started_connected && defined $self->_dbh;
1266 sub _determine_connector_driver {
1267 my ($self, $conn) = @_;
1269 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1272 $self->_warn_undetermined_driver(
1273 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1274 . "$conn connector - this should not have happened."
1279 $dbtype =~ s/\W/_/gi;
1281 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1282 return if $self->isa($subclass);
1284 if ($self->load_optional_class($subclass)) {
1285 bless $self, $subclass;
1289 $self->_warn_undetermined_driver(
1290 'This version of DBIC does not yet seem to supply a driver for '
1291 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1296 sub _warn_undetermined_driver {
1297 my ($self, $msg) = @_;
1299 require Data::Dumper::Concise;
1301 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1302 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1303 . "does not go away, file a bugreport including the following info:\n"
1304 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1308 sub _do_connection_actions {
1310 my $method_prefix = shift;
1313 if (not ref($call)) {
1314 my $method = $method_prefix . $call;
1316 } elsif (ref($call) eq 'CODE') {
1318 } elsif (ref($call) eq 'ARRAY') {
1319 if (ref($call->[0]) ne 'ARRAY') {
1320 $self->_do_connection_actions($method_prefix, $_) for @$call;
1322 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1325 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1331 sub connect_call_do_sql {
1333 $self->_do_query(@_);
1336 sub disconnect_call_do_sql {
1338 $self->_do_query(@_);
1341 # override in db-specific backend when necessary
1342 sub connect_call_datetime_setup { 1 }
1345 my ($self, $action) = @_;
1347 if (ref $action eq 'CODE') {
1348 $action = $action->($self);
1349 $self->_do_query($_) foreach @$action;
1352 # Most debuggers expect ($sql, @bind), so we need to exclude
1353 # the attribute hash which is the second argument to $dbh->do
1354 # furthermore the bind values are usually to be presented
1355 # as named arrayref pairs, so wrap those here too
1356 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1357 my $sql = shift @do_args;
1358 my $attrs = shift @do_args;
1359 my @bind = map { [ undef, $_ ] } @do_args;
1362 $_[0]->_query_start($sql, \@bind);
1363 $_[1]->do($sql, $attrs, @do_args);
1364 $_[0]->_query_end($sql, \@bind);
1372 my ($self, @info) = @_;
1374 $self->throw_exception("You failed to provide any connection info")
1377 my ($old_connect_via, $dbh);
1379 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1382 if(ref $info[0] eq 'CODE') {
1383 $dbh = $info[0]->();
1387 $dbh = DBI->connect(@info);
1394 unless ($self->unsafe) {
1396 $self->throw_exception(
1397 'Refusing clobbering of {HandleError} installed on externally supplied '
1398 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1399 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1401 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1402 # request, or an external handle. Complain and set anyway
1403 unless ($dbh->{RaiseError}) {
1404 carp( ref $info[0] eq 'CODE'
1406 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1407 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1408 .'attribute has been supplied'
1410 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1411 .'unsafe => 1. Toggling RaiseError back to true'
1414 $dbh->{RaiseError} = 1;
1417 # this odd anonymous coderef dereference is in fact really
1418 # necessary to avoid the unwanted effect described in perl5
1421 my $weak_self = $_[0];
1424 # the coderef is blessed so we can distinguish it from externally
1425 # supplied handles (which must be preserved)
1426 $_[1]->{HandleError} = bless sub {
1428 $weak_self->throw_exception("DBI Exception: $_[0]");
1431 # the handler may be invoked by something totally out of
1433 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1435 }, '__DBIC__DBH__ERROR__HANDLER__';
1440 $self->throw_exception("DBI Connection failed: $_")
1443 $self->_dbh_autocommit($dbh->{AutoCommit});
1450 # this means we have not yet connected and do not know the AC status
1451 # (e.g. coderef $dbh), need a full-fledged connection check
1452 if (! defined $self->_dbh_autocommit) {
1453 $self->ensure_connected;
1455 # Otherwise simply connect or re-connect on pid changes
1460 $self->next::method(@_);
1463 sub _exec_txn_begin {
1466 # if the user is utilizing txn_do - good for him, otherwise we need to
1467 # ensure that the $dbh is healthy on BEGIN.
1468 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1469 # will be replaced by a failure of begin_work itself (which will be
1470 # then retried on reconnect)
1471 if ($self->{_in_do_block}) {
1472 $self->_dbh->begin_work;
1474 $self->dbh_do(sub { $_[1]->begin_work });
1481 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1482 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1485 # esoteric case for folks using external $dbh handles
1486 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1487 carp "Storage transaction_depth 0 does not match "
1488 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1489 $self->transaction_depth(1);
1492 $self->next::method(@_);
1494 # if AutoCommit is disabled txn_depth never goes to 0
1495 # as a new txn is started immediately on commit
1496 $self->transaction_depth(1) if (
1497 !$self->transaction_depth
1499 defined $self->_dbh_autocommit
1501 ! $self->_dbh_autocommit
1505 sub _exec_txn_commit {
1506 shift->_dbh->commit;
1512 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1513 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1516 # esoteric case for folks using external $dbh handles
1517 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1518 carp "Storage transaction_depth 0 does not match "
1519 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1520 $self->transaction_depth(1);
1523 $self->next::method(@_);
1525 # if AutoCommit is disabled txn_depth never goes to 0
1526 # as a new txn is started immediately on commit
1527 $self->transaction_depth(1) if (
1528 !$self->transaction_depth
1530 defined $self->_dbh_autocommit
1532 ! $self->_dbh_autocommit
1536 sub _exec_txn_rollback {
1537 shift->_dbh->rollback;
1540 # generate some identical methods
1541 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1543 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1545 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1546 $self->throw_exception("Unable to $meth() on a disconnected storage")
1548 $self->next::method(@_);
1552 # This used to be the top-half of _execute. It was split out to make it
1553 # easier to override in NoBindVars without duping the rest. It takes up
1554 # all of _execute's args, and emits $sql, @bind.
1555 sub _prep_for_execute {
1556 #my ($self, $op, $ident, $args) = @_;
1557 return shift->_gen_sql_bind(@_)
1561 my ($self, $op, $ident, $args) = @_;
1563 my ($sql, @bind) = $self->sql_maker->$op(
1564 blessed($ident) ? $ident->from : $ident,
1569 ! $ENV{DBIC_DT_SEARCH_OK}
1573 first { blessed($_->[1]) && $_->[1]->isa('DateTime') } @bind
1575 carp_unique 'DateTime objects passed to search() are not supported '
1576 . 'properly (InflateColumn::DateTime formats and settings are not '
1577 . 'respected.) See "Formatting DateTime objects in queries" in '
1578 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1579 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1582 return( $sql, $self->_resolve_bindattrs(
1583 $ident, [ @{$args->[2]{bind}||[]}, @bind ]
1587 sub _resolve_bindattrs {
1588 my ($self, $ident, $bind, $colinfos) = @_;
1592 my $resolve_bindinfo = sub {
1593 #my $infohash = shift;
1595 %$colinfos = %{ $self->_resolve_column_info($ident) }
1596 unless keys %$colinfos;
1599 if (my $col = $_[0]->{dbic_colname}) {
1600 $ret = { %{$_[0]} };
1602 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1603 if $colinfos->{$col}{data_type};
1605 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1606 if $colinfos->{$col}{size};
1613 if (ref $_ ne 'ARRAY') {
1616 elsif (! defined $_->[0]) {
1619 elsif (ref $_->[0] eq 'HASH') {
1621 ($_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype}) ? $_->[0] : $resolve_bindinfo->($_->[0]),
1625 elsif (ref $_->[0] eq 'SCALAR') {
1626 [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1629 [ $resolve_bindinfo->({ dbic_colname => $_->[0] }), $_->[1] ]
1634 sub _format_for_trace {
1635 #my ($self, $bind) = @_;
1637 ### Turn @bind from something like this:
1638 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1640 ### ( "'1'", "'3'" )
1643 defined( $_ && $_->[1] )
1650 my ( $self, $sql, $bind ) = @_;
1652 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1657 my ( $self, $sql, $bind ) = @_;
1659 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1664 sub _dbi_attrs_for_bind {
1665 my ($self, $ident, $bind) = @_;
1667 if (! defined $sba_compat) {
1668 $self->_determine_driver;
1669 $sba_compat = $self->can('source_bind_attributes') == \&source_bind_attributes
1677 my $class = ref $self;
1679 "The source_bind_attributes() override in $class relies on a deprecated codepath. "
1680 .'You are strongly advised to switch your code to override bind_attribute_by_datatype() '
1681 .'instead. This legacy compat shim will also disappear some time before DBIC 0.09'
1684 my $sba_attrs = $self->source_bind_attributes
1689 for (map { $_->[0] } @$bind) {
1691 if (exists $_->{dbd_attrs}) {
1694 elsif($_->{sqlt_datatype}) {
1695 # cache the result in the dbh_details hash, as it can not change unless
1696 # we connect to something else
1697 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1698 if (not exists $cache->{$_->{sqlt_datatype}}) {
1699 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1701 $cache->{$_->{sqlt_datatype}};
1703 elsif ($sba_attrs and $_->{dbic_colname}) {
1704 $sba_attrs->{$_->{dbic_colname}} || undef;
1707 undef; # always push something at this position
1716 my ($self, $op, $ident, @args) = @_;
1718 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1720 shift->dbh_do( # retry over disconnects
1724 $self->_dbi_attrs_for_bind($ident, $bind)
1729 my ($self, undef, $sql, $bind, $bind_attrs) = @_;
1731 $self->_query_start( $sql, $bind );
1732 my $sth = $self->_sth($sql);
1734 for my $i (0 .. $#$bind) {
1735 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1736 $sth->bind_param_inout(
1737 $i + 1, # bind params counts are 1-based
1739 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1746 (ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""'))
1755 # Can this fail without throwing an exception anyways???
1756 my $rv = $sth->execute();
1757 $self->throw_exception(
1758 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1761 $self->_query_end( $sql, $bind );
1763 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1766 sub _prefetch_autovalues {
1767 my ($self, $source, $to_insert) = @_;
1769 my $colinfo = $source->columns_info;
1772 for my $col (keys %$colinfo) {
1774 $colinfo->{$col}{auto_nextval}
1777 ! exists $to_insert->{$col}
1779 ref $to_insert->{$col} eq 'SCALAR'
1781 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1784 $values{$col} = $self->_sequence_fetch(
1786 ( $colinfo->{$col}{sequence} ||=
1787 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1797 my ($self, $source, $to_insert) = @_;
1799 my $prefetched_values = $self->_prefetch_autovalues($source, $to_insert);
1801 # fuse the values, but keep a separate list of prefetched_values so that
1802 # they can be fused once again with the final return
1803 $to_insert = { %$to_insert, %$prefetched_values };
1805 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1806 # Investigate what does it take to s/defined/exists/
1807 my $col_infos = $source->columns_info;
1808 my %pcols = map { $_ => 1 } $source->primary_columns;
1809 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1810 for my $col ($source->columns) {
1811 if ($col_infos->{$col}{is_auto_increment}) {
1812 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1813 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1816 # nothing to retrieve when explicit values are supplied
1817 next if (defined $to_insert->{$col} and ! (
1818 ref $to_insert->{$col} eq 'SCALAR'
1820 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1823 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1824 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1827 $col_infos->{$col}{retrieve_on_insert}
1831 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1832 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1834 my ($sqla_opts, @ir_container);
1835 if (%retrieve_cols and $self->_use_insert_returning) {
1836 $sqla_opts->{returning_container} = \@ir_container
1837 if $self->_use_insert_returning_bound;
1839 $sqla_opts->{returning} = [
1840 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1844 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1846 my %returned_cols = %$to_insert;
1847 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1848 @ir_container = try {
1849 local $SIG{__WARN__} = sub {};
1850 my @r = $sth->fetchrow_array;
1853 } unless @ir_container;
1855 @returned_cols{@$retlist} = @ir_container if @ir_container;
1858 # pull in PK if needed and then everything else
1859 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1861 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1862 unless $self->can('last_insert_id');
1864 my @pri_values = $self->last_insert_id($source, @missing_pri);
1866 $self->throw_exception( "Can't get last insert id" )
1867 unless (@pri_values == @missing_pri);
1869 @returned_cols{@missing_pri} = @pri_values;
1870 delete $retrieve_cols{$_} for @missing_pri;
1873 # if there is more left to pull
1874 if (%retrieve_cols) {
1875 $self->throw_exception(
1876 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1879 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1881 my $cur = DBIx::Class::ResultSet->new($source, {
1882 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
1883 select => \@left_to_fetch,
1886 @returned_cols{@left_to_fetch} = $cur->next;
1888 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
1889 if scalar $cur->next;
1893 return { %$prefetched_values, %returned_cols };
1897 my ($self, $source, $cols, $data) = @_;
1899 my @col_range = (0..$#$cols);
1901 # FIXME - perhaps this is not even needed? does DBI stringify?
1903 # forcibly stringify whatever is stringifiable
1904 # ResultSet::populate() hands us a copy - safe to mangle
1905 for my $r (0 .. $#$data) {
1906 for my $c (0 .. $#{$data->[$r]}) {
1907 $data->[$r][$c] = "$data->[$r][$c]"
1908 if ( ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
1912 my $colinfos = $source->columns_info($cols);
1914 local $self->{_autoinc_supplied_for_op} =
1915 (first { $_->{is_auto_increment} } values %$colinfos)
1920 # get a slice type index based on first row of data
1921 # a "column" in this context may refer to more than one bind value
1922 # e.g. \[ '?, ?', [...], [...] ]
1924 # construct the value type index - a description of values types for every
1925 # per-column slice of $data:
1927 # nonexistent - nonbind literal
1929 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
1931 # also construct the column hash to pass to the SQL generator. For plain
1932 # (non literal) values - convert the members of the first row into a
1933 # literal+bind combo, with extra positional info in the bind attr hashref.
1934 # This will allow us to match the order properly, and is so contrived
1935 # because a user-supplied literal/bind (or something else specific to a
1936 # resultsource and/or storage driver) can inject extra binds along the
1937 # way, so one can't rely on "shift positions" ordering at all. Also we
1938 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
1939 # can be later matched up by address), because we want to supply a real
1940 # value on which perhaps e.g. datatype checks will be performed
1941 my ($proto_data, $value_type_idx);
1942 for my $i (@col_range) {
1943 my $colname = $cols->[$i];
1944 if (ref $data->[0][$i] eq 'SCALAR') {
1945 # no bind value at all - no type
1947 $proto_data->{$colname} = $data->[0][$i];
1949 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
1950 # repack, so we don't end up mangling the original \[]
1951 my ($sql, @bind) = @${$data->[0][$i]};
1953 # normalization of user supplied stuff
1954 my $resolved_bind = $self->_resolve_bindattrs(
1955 $source, \@bind, $colinfos,
1958 # store value-less (attrs only) bind info - we will be comparing all
1959 # supplied binds against this for sanity
1960 $value_type_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
1962 $proto_data->{$colname} = \[ $sql, map { [
1963 # inject slice order to use for $proto_bind construction
1964 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i }
1966 $resolved_bind->[$_][1]
1971 $value_type_idx->{$i} = 0;
1973 $proto_data->{$colname} = \[ '?', [
1974 { dbic_colname => $colname, _bind_data_slice_idx => $i }
1981 my ($sql, $proto_bind) = $self->_prep_for_execute (
1987 if (! @$proto_bind and keys %$value_type_idx) {
1988 # if the bindlist is empty and we had some dynamic binds, this means the
1989 # storage ate them away (e.g. the NoBindVars component) and interpolated
1990 # them directly into the SQL. This obviously can't be good for multi-inserts
1991 $self->throw_exception('Cannot insert_bulk without support for placeholders');
1995 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
1997 # use an error reporting closure for convenience (less to pass)
1998 my $bad_slice_report_cref = sub {
1999 my ($msg, $r_idx, $c_idx) = @_;
2000 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2004 require Data::Dumper::Concise;
2005 local $Data::Dumper::Maxdepth = 5;
2006 Data::Dumper::Concise::Dumper ({
2007 map { $cols->[$_] =>
2015 for my $col_idx (@col_range) {
2016 my $reference_val = $data->[0][$col_idx];
2018 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2019 my $val = $data->[$row_idx][$col_idx];
2021 if (! exists $value_type_idx->{$col_idx}) { # literal no binds
2022 if (ref $val ne 'SCALAR') {
2023 $bad_slice_report_cref->(
2024 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2029 elsif ($$val ne $$reference_val) {
2030 $bad_slice_report_cref->(
2031 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2037 elsif (! $value_type_idx->{$col_idx} ) { # regular non-literal value
2038 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
2039 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2042 else { # binds from a \[], compare type and attrs
2043 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2044 $bad_slice_report_cref->(
2045 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2050 # start drilling down and bail out early on identical refs
2052 $reference_val != $val
2054 $$reference_val != $$val
2056 if (${$val}->[0] ne ${$reference_val}->[0]) {
2057 $bad_slice_report_cref->(
2058 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2063 # need to check the bind attrs - a bind will happen only once for
2064 # the entire dataset, so any changes further down will be ignored.
2065 elsif (! Data::Compare::Compare(
2066 $value_type_idx->{$col_idx},
2070 @{$self->_resolve_bindattrs(
2071 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2075 $bad_slice_report_cref->(
2076 'Differing bind attributes on literal/bind values not supported',
2086 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2087 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2089 my $guard = $self->txn_scope_guard;
2091 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2092 my $sth = $self->_sth($sql);
2095 # proto bind contains the information on which pieces of $data to pull
2096 # $cols is passed in only for prettier error-reporting
2097 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2100 # bind_param_array doesn't work if there are no binds
2101 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2105 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2109 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2112 # execute_for_fetch is capable of returning data just fine (it means it
2113 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2114 # is the void-populate fast-path we will just ignore this altogether
2115 # for the time being.
2116 sub _dbh_execute_for_fetch {
2117 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2119 my @idx_range = ( 0 .. $#$proto_bind );
2121 # If we have any bind attributes to take care of, we will bind the
2122 # proto-bind data (which will never be used by execute_for_fetch)
2123 # However since column bindtypes are "sticky", this is sufficient
2124 # to get the DBD to apply the bindtype to all values later on
2126 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2128 for my $i (@idx_range) {
2130 $i+1, # DBI bind indexes are 1-based
2131 $proto_bind->[$i][1],
2133 ) if defined $bind_attrs->[$i];
2136 # At this point $data slots named in the _bind_data_slice_idx of
2137 # each piece of $proto_bind are either \[]s or plain values to be
2138 # passed in. Construct the dispensing coderef. *NOTE* the order
2139 # of $data will differ from this of the ?s in the SQL (due to
2140 # alphabetical ordering by colname). We actually do want to
2141 # preserve this behavior so that prepare_cached has a better
2142 # chance of matching on unrelated calls
2143 my %data_reorder = map { $proto_bind->[$_][0]{_bind_data_slice_idx} => $_ } @idx_range;
2145 my $fetch_row_idx = -1; # saner loop this way
2146 my $fetch_tuple = sub {
2147 return undef if ++$fetch_row_idx > $#$data;
2150 { (ref $_ eq 'REF' and ref $$_ eq 'ARRAY')
2151 ? map { $_->[-1] } @{$$_}[1 .. $#$$_]
2155 { $data->[$fetch_row_idx][$_]}
2157 { $data_reorder{$a} <=> $data_reorder{$b} }
2162 my $tuple_status = [];
2165 $rv = $sth->execute_for_fetch(
2174 # Not all DBDs are create equal. Some throw on error, some return
2175 # an undef $rv, and some set $sth->err - try whatever we can
2176 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2179 ( !defined $rv or $sth->err )
2182 # Statement must finish even if there was an exception.
2187 $err = shift unless defined $err
2192 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2194 $self->throw_exception("Unexpected populate error: $err")
2195 if ($i > $#$tuple_status);
2197 require Data::Dumper::Concise;
2198 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2199 ($tuple_status->[$i][1] || $err),
2200 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2207 sub _dbh_execute_inserts_with_no_binds {
2208 my ($self, $sth, $count) = @_;
2212 my $dbh = $self->_get_dbh;
2213 local $dbh->{RaiseError} = 1;
2214 local $dbh->{PrintError} = 0;
2216 $sth->execute foreach 1..$count;
2222 # Make sure statement is finished even if there was an exception.
2227 $err = shift unless defined $err;
2230 $self->throw_exception($err) if defined $err;
2236 #my ($self, $source, @args) = @_;
2237 shift->_execute('update', @_);
2242 #my ($self, $source, @args) = @_;
2243 shift->_execute('delete', @_);
2248 $self->_execute($self->_select_args(@_));
2251 sub _select_args_to_query {
2254 $self->throw_exception(
2255 "Unable to generate limited query representation with 'software_limit' enabled"
2256 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2258 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2259 # = $self->_select_args($ident, $select, $cond, $attrs);
2260 my ($op, $ident, @args) =
2261 $self->_select_args(@_);
2263 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2264 my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, \@args);
2265 $prepared_bind ||= [];
2268 ? ($sql, $prepared_bind)
2269 : \[ "($sql)", @$prepared_bind ]
2274 my ($self, $ident, $select, $where, $attrs) = @_;
2276 my $sql_maker = $self->sql_maker;
2277 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
2284 $rs_alias && $alias2source->{$rs_alias}
2285 ? ( _rsroot_rsrc => $alias2source->{$rs_alias} )
2290 # Sanity check the attributes (SQLMaker does it too, but
2291 # in case of a software_limit we'll never reach there)
2292 if (defined $attrs->{offset}) {
2293 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2294 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2297 if (defined $attrs->{rows}) {
2298 $self->throw_exception("The rows attribute must be a positive integer if present")
2299 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2301 elsif ($attrs->{offset}) {
2302 # MySQL actually recommends this approach. I cringe.
2303 $attrs->{rows} = $sql_maker->__max_int;
2308 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
2309 # storage, unless software limit was requested
2312 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
2314 # grouped prefetch (to satisfy group_by == select)
2315 ( $attrs->{group_by}
2317 @{$attrs->{group_by}}
2319 $attrs->{_prefetch_selector_range}
2322 ($ident, $select, $where, $attrs)
2323 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2325 elsif (! $attrs->{software_limit} ) {
2327 $attrs->{rows} || (),
2328 $attrs->{offset} || (),
2332 # try to simplify the joinmap further (prune unreferenced type-single joins)
2336 reftype $ident eq 'ARRAY'
2340 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2344 # This would be the point to deflate anything found in $where
2345 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2346 # expect a row object. And all we have is a resultsource (it is trivial
2347 # to extract deflator coderefs via $alias2source above).
2349 # I don't see a way forward other than changing the way deflators are
2350 # invoked, and that's just bad...
2353 return ('select', $ident, $select, $where, $attrs, @limit);
2356 # Returns a counting SELECT for a simple count
2357 # query. Abstracted so that a storage could override
2358 # this to { count => 'firstcol' } or whatever makes
2359 # sense as a performance optimization
2361 #my ($self, $source, $rs_attrs) = @_;
2362 return { count => '*' };
2365 sub source_bind_attributes {
2366 shift->throw_exception(
2367 'source_bind_attributes() was never meant to be a callable public method - '
2368 .'please contact the DBIC dev-team and describe your use case so that a reasonable '
2369 .'solution can be provided'
2370 ."\nhttp://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT"
2378 =item Arguments: $ident, $select, $condition, $attrs
2382 Handle a SQL select statement.
2388 my ($ident, $select, $condition, $attrs) = @_;
2389 return $self->cursor_class->new($self, \@_, $attrs);
2394 my ($rv, $sth, @bind) = $self->_select(@_);
2395 my @row = $sth->fetchrow_array;
2396 my @nextrow = $sth->fetchrow_array if @row;
2397 if(@row && @nextrow) {
2398 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2400 # Need to call finish() to work round broken DBDs
2405 =head2 sql_limit_dialect
2407 This is an accessor for the default SQL limit dialect used by a particular
2408 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2409 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2410 see L<DBIx::Class::SQLMaker::LimitDialects>.
2415 my ($self, $dbh, $sql) = @_;
2417 # 3 is the if_active parameter which avoids active sth re-use
2418 my $sth = $self->disable_sth_caching
2419 ? $dbh->prepare($sql)
2420 : $dbh->prepare_cached($sql, {}, 3);
2422 # XXX You would think RaiseError would make this impossible,
2423 # but apparently that's not true :(
2424 $self->throw_exception(
2427 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
2428 .'an exception and/or setting $dbh->errstr',
2430 ? substr($sql, 0, 20) . '...'
2433 'DBD::' . $dbh->{Driver}{Name},
2441 carp_unique 'sth was mistakenly marked/documented as public, stop calling it (will be removed before DBIC v0.09)';
2446 my ($self, $sql) = @_;
2447 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2450 sub _dbh_columns_info_for {
2451 my ($self, $dbh, $table) = @_;
2453 if ($dbh->can('column_info')) {
2457 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2458 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2460 while ( my $info = $sth->fetchrow_hashref() ){
2462 $column_info{data_type} = $info->{TYPE_NAME};
2463 $column_info{size} = $info->{COLUMN_SIZE};
2464 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2465 $column_info{default_value} = $info->{COLUMN_DEF};
2466 my $col_name = $info->{COLUMN_NAME};
2467 $col_name =~ s/^\"(.*)\"$/$1/;
2469 $result{$col_name} = \%column_info;
2474 return \%result if !$caught && scalar keys %result;
2478 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2480 my @columns = @{$sth->{NAME_lc}};
2481 for my $i ( 0 .. $#columns ){
2483 $column_info{data_type} = $sth->{TYPE}->[$i];
2484 $column_info{size} = $sth->{PRECISION}->[$i];
2485 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2487 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2488 $column_info{data_type} = $1;
2489 $column_info{size} = $2;
2492 $result{$columns[$i]} = \%column_info;
2496 foreach my $col (keys %result) {
2497 my $colinfo = $result{$col};
2498 my $type_num = $colinfo->{data_type};
2500 if(defined $type_num && $dbh->can('type_info')) {
2501 my $type_info = $dbh->type_info($type_num);
2502 $type_name = $type_info->{TYPE_NAME} if $type_info;
2503 $colinfo->{data_type} = $type_name if $type_name;
2510 sub columns_info_for {
2511 my ($self, $table) = @_;
2512 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2515 =head2 last_insert_id
2517 Return the row id of the last insert.
2521 sub _dbh_last_insert_id {
2522 my ($self, $dbh, $source, $col) = @_;
2524 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2526 return $id if defined $id;
2528 my $class = ref $self;
2529 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2532 sub last_insert_id {
2534 $self->_dbh_last_insert_id ($self->_dbh, @_);
2537 =head2 _native_data_type
2541 =item Arguments: $type_name
2545 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2546 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2547 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2549 The default implementation returns C<undef>, implement in your Storage driver if
2550 you need this functionality.
2552 Should map types from other databases to the native RDBMS type, for example
2553 C<VARCHAR2> to C<VARCHAR>.
2555 Types with modifiers should map to the underlying data type. For example,
2556 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2558 Composite types should map to the container type, for example
2559 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2563 sub _native_data_type {
2564 #my ($self, $data_type) = @_;
2568 # Check if placeholders are supported at all
2569 sub _determine_supports_placeholders {
2571 my $dbh = $self->_get_dbh;
2573 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2574 # but it is inaccurate more often than not
2576 local $dbh->{PrintError} = 0;
2577 local $dbh->{RaiseError} = 1;
2578 $dbh->do('select ?', {}, 1);
2586 # Check if placeholders bound to non-string types throw exceptions
2588 sub _determine_supports_typeless_placeholders {
2590 my $dbh = $self->_get_dbh;
2593 local $dbh->{PrintError} = 0;
2594 local $dbh->{RaiseError} = 1;
2595 # this specifically tests a bind that is NOT a string
2596 $dbh->do('select 1 where 1 = ?', {}, 1);
2606 Returns the database driver name.
2611 shift->_get_dbh->{Driver}->{Name};
2614 =head2 bind_attribute_by_data_type
2616 Given a datatype from column info, returns a database specific bind
2617 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2618 let the database planner just handle it.
2620 Generally only needed for special case column types, like bytea in postgres.
2624 sub bind_attribute_by_data_type {
2628 =head2 is_datatype_numeric
2630 Given a datatype from column_info, returns a boolean value indicating if
2631 the current RDBMS considers it a numeric value. This controls how
2632 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2633 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2634 be performed instead of the usual C<eq>.
2638 sub is_datatype_numeric {
2639 #my ($self, $dt) = @_;
2641 return 0 unless $_[1];
2644 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2649 =head2 create_ddl_dir
2653 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2657 Creates a SQL file based on the Schema, for each of the specified
2658 database engines in C<\@databases> in the given directory.
2659 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2661 Given a previous version number, this will also create a file containing
2662 the ALTER TABLE statements to transform the previous schema into the
2663 current one. Note that these statements may contain C<DROP TABLE> or
2664 C<DROP COLUMN> statements that can potentially destroy data.
2666 The file names are created using the C<ddl_filename> method below, please
2667 override this method in your schema if you would like a different file
2668 name format. For the ALTER file, the same format is used, replacing
2669 $version in the name with "$preversion-$version".
2671 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2672 The most common value for this would be C<< { add_drop_table => 1 } >>
2673 to have the SQL produced include a C<DROP TABLE> statement for each table
2674 created. For quoting purposes supply C<quote_table_names> and
2675 C<quote_field_names>.
2677 If no arguments are passed, then the following default values are assumed:
2681 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2683 =item version - $schema->schema_version
2685 =item directory - './'
2687 =item preversion - <none>
2691 By default, C<\%sqlt_args> will have
2693 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2695 merged with the hash passed in. To disable any of those features, pass in a
2696 hashref like the following
2698 { ignore_constraint_names => 0, # ... other options }
2701 WARNING: You are strongly advised to check all SQL files created, before applying
2706 sub create_ddl_dir {
2707 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2710 carp "No directory given, using ./\n";
2715 (require File::Path and File::Path::make_path ("$dir")) # make_path does not like objects (i.e. Path::Class::Dir)
2717 $self->throw_exception(
2718 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2722 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2724 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2725 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2727 my $schema_version = $schema->schema_version || '1.x';
2728 $version ||= $schema_version;
2731 add_drop_table => 1,
2732 ignore_constraint_names => 1,
2733 ignore_index_names => 1,
2737 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2738 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2741 my $sqlt = SQL::Translator->new( $sqltargs );
2743 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2744 my $sqlt_schema = $sqlt->translate({ data => $schema })
2745 or $self->throw_exception ($sqlt->error);
2747 foreach my $db (@$databases) {
2749 $sqlt->{schema} = $sqlt_schema;
2750 $sqlt->producer($db);
2753 my $filename = $schema->ddl_filename($db, $version, $dir);
2754 if (-e $filename && ($version eq $schema_version )) {
2755 # if we are dumping the current version, overwrite the DDL
2756 carp "Overwriting existing DDL file - $filename";
2760 my $output = $sqlt->translate;
2762 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2765 if(!open($file, ">$filename")) {
2766 $self->throw_exception("Can't open $filename for writing ($!)");
2769 print $file $output;
2772 next unless ($preversion);
2774 require SQL::Translator::Diff;
2776 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2777 if(!-e $prefilename) {
2778 carp("No previous schema file found ($prefilename)");
2782 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2784 carp("Overwriting existing diff file - $difffile");
2790 my $t = SQL::Translator->new($sqltargs);
2795 or $self->throw_exception ($t->error);
2797 my $out = $t->translate( $prefilename )
2798 or $self->throw_exception ($t->error);
2800 $source_schema = $t->schema;
2802 $source_schema->name( $prefilename )
2803 unless ( $source_schema->name );
2806 # The "new" style of producers have sane normalization and can support
2807 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2808 # And we have to diff parsed SQL against parsed SQL.
2809 my $dest_schema = $sqlt_schema;
2811 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2812 my $t = SQL::Translator->new($sqltargs);
2817 or $self->throw_exception ($t->error);
2819 my $out = $t->translate( $filename )
2820 or $self->throw_exception ($t->error);
2822 $dest_schema = $t->schema;
2824 $dest_schema->name( $filename )
2825 unless $dest_schema->name;
2828 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2832 if(!open $file, ">$difffile") {
2833 $self->throw_exception("Can't write to $difffile ($!)");
2841 =head2 deployment_statements
2845 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2849 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2851 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2852 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2854 C<$directory> is used to return statements from files in a previously created
2855 L</create_ddl_dir> directory and is optional. The filenames are constructed
2856 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2858 If no C<$directory> is specified then the statements are constructed on the
2859 fly using L<SQL::Translator> and C<$version> is ignored.
2861 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2865 sub deployment_statements {
2866 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2867 $type ||= $self->sqlt_type;
2868 $version ||= $schema->schema_version || '1.x';
2870 my $filename = $schema->ddl_filename($type, $version, $dir);
2873 # FIXME replace this block when a proper sane sql parser is available
2875 open($file, "<$filename")
2876 or $self->throw_exception("Can't open $filename ($!)");
2879 return join('', @rows);
2882 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2883 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2886 # sources needs to be a parser arg, but for simplicty allow at top level
2888 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2889 if exists $sqltargs->{sources};
2891 my $tr = SQL::Translator->new(
2892 producer => "SQL::Translator::Producer::${type}",
2894 parser => 'SQL::Translator::Parser::DBIx::Class',
2898 return preserve_context {
2901 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2902 unless defined $_[0];
2906 # FIXME deploy() currently does not accurately report sql errors
2907 # Will always return true while errors are warned
2909 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2913 return if($line =~ /^--/);
2914 # next if($line =~ /^DROP/m);
2915 return if($line =~ /^BEGIN TRANSACTION/m);
2916 return if($line =~ /^COMMIT/m);
2917 return if $line =~ /^\s+$/; # skip whitespace only
2918 $self->_query_start($line);
2920 # do a dbh_do cycle here, as we need some error checking in
2921 # place (even though we will ignore errors)
2922 $self->dbh_do (sub { $_[1]->do($line) });
2924 carp qq{$_ (running "${line}")};
2926 $self->_query_end($line);
2928 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2929 if (@statements > 1) {
2930 foreach my $statement (@statements) {
2931 $deploy->( $statement );
2934 elsif (@statements == 1) {
2935 # split on single line comments and end of statements
2936 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
2942 =head2 datetime_parser
2944 Returns the datetime parser class
2948 sub datetime_parser {
2950 return $self->{datetime_parser} ||= do {
2951 $self->build_datetime_parser(@_);
2955 =head2 datetime_parser_type
2957 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
2959 =head2 build_datetime_parser
2961 See L</datetime_parser>
2965 sub build_datetime_parser {
2967 my $type = $self->datetime_parser_type(@_);
2972 =head2 is_replicating
2974 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2975 replicate from a master database. Default is undef, which is the result
2976 returned by databases that don't support replication.
2980 sub is_replicating {
2985 =head2 lag_behind_master
2987 Returns a number that represents a certain amount of lag behind a master db
2988 when a given storage is replicating. The number is database dependent, but
2989 starts at zero and increases with the amount of lag. Default in undef
2993 sub lag_behind_master {
2997 =head2 relname_to_table_alias
3001 =item Arguments: $relname, $join_count
3005 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3008 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3009 way these aliases are named.
3011 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3012 otherwise C<"$relname">.
3016 sub relname_to_table_alias {
3017 my ($self, $relname, $join_count) = @_;
3019 my $alias = ($join_count && $join_count > 1 ?
3020 join('_', $relname, $join_count) : $relname);
3025 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3026 # version and it may be necessary to amend or override it for a specific storage
3027 # if such binds are necessary.
3028 sub _max_column_bytesize {
3029 my ($self, $attr) = @_;
3033 if ($attr->{sqlt_datatype}) {
3034 my $data_type = lc($attr->{sqlt_datatype});
3036 if ($attr->{sqlt_size}) {
3038 # String/sized-binary types
3039 if ($data_type =~ /^(?:
3040 l? (?:var)? char(?:acter)? (?:\s*varying)?
3042 (?:var)? binary (?:\s*varying)?
3047 $max_size = $attr->{sqlt_size};
3049 # Other charset/unicode types, assume scale of 4
3050 elsif ($data_type =~ /^(?:
3051 national \s* character (?:\s*varying)?
3060 $max_size = $attr->{sqlt_size} * 4;
3064 if (!$max_size and !$self->_is_lob_type($data_type)) {
3065 $max_size = 100 # for all other (numeric?) datatypes
3069 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3072 # Determine if a data_type is some type of BLOB
3074 my ($self, $data_type) = @_;
3075 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3076 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3077 |varchar|character\s*varying|nvarchar
3078 |national\s*character\s*varying))?\z/xi);
3081 sub _is_binary_lob_type {
3082 my ($self, $data_type) = @_;
3083 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3084 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3087 sub _is_text_lob_type {
3088 my ($self, $data_type) = @_;
3089 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3090 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3091 |national\s*character\s*varying))\z/xi);
3094 # Determine if a data_type is some type of a binary type
3095 sub _is_binary_type {
3096 my ($self, $data_type) = @_;
3097 $data_type && ($self->_is_binary_lob_type($data_type)
3098 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3105 =head2 DBIx::Class and AutoCommit
3107 DBIx::Class can do some wonderful magic with handling exceptions,
3108 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3109 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3110 transaction support.
3112 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3113 in an assumed transaction between commits, and you're telling us you'd
3114 like to manage that manually. A lot of the magic protections offered by
3115 this module will go away. We can't protect you from exceptions due to database
3116 disconnects because we don't know anything about how to restart your
3117 transactions. You're on your own for handling all sorts of exceptional
3118 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3124 Matt S. Trout <mst@shadowcatsystems.co.uk>
3126 Andy Grundman <andy@hybridized.org>
3130 You may distribute this code under the same terms as Perl itself.