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 Carp::Clan qw/^DBIx::Class|^Try::Tiny/;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use Scalar::Util qw/refaddr weaken reftype blessed/;
14 use List::Util qw/first/;
15 use Sub::Name 'subname';
21 # default cursor class, overridable in connect_info attributes
22 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
24 __PACKAGE__->mk_group_accessors('inherited' => qw/
25 sql_maker_class sql_limit_dialect sql_quote_char sql_name_sep
28 __PACKAGE__->sql_name_sep('.');
30 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
32 __PACKAGE__->mk_group_accessors('simple' => qw/
33 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
34 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts
35 transaction_depth _dbh_autocommit savepoints
38 # the values for these accessors are picked out (and deleted) from
39 # the attribute hashref passed to connect_info
40 my @storage_options = qw/
41 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
42 disable_sth_caching unsafe auto_savepoint
44 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
47 # capability definitions, using a 2-tiered accessor system
50 # A driver/user may define _use_X, which blindly without any checks says:
51 # "(do not) use this capability", (use_dbms_capability is an "inherited"
54 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
55 # accessor, which in turn calls _determine_supports_X, and stores the return
56 # in a special slot on the storage object, which is wiped every time a $dbh
57 # reconnection takes place (it is not guaranteed that upon reconnection we
58 # will get the same rdbms version). _determine_supports_X does not need to
59 # exist on a driver, as we ->can for it before calling.
61 my @capabilities = (qw/
63 insert_returning_bound
68 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
69 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
71 # on by default, not strictly a capability (pending rewrite)
72 __PACKAGE__->_use_join_optimizer (1);
73 sub _determine_supports_join_optimizer { 1 };
75 # Each of these methods need _determine_driver called before itself
76 # in order to function reliably. This is a purely DRY optimization
78 # get_(use)_dbms_capability need to be called on the correct Storage
79 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
80 # _determine_supports_X which obv. needs a correct driver as well
81 my @rdbms_specific_methods = qw/
95 get_use_dbms_capability
102 for my $meth (@rdbms_specific_methods) {
104 my $orig = __PACKAGE__->can ($meth)
105 or die "$meth is not a ::Storage::DBI method!";
108 no warnings qw/redefine/;
109 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
110 if (not $_[0]->_driver_determined and not $_[0]->{_in_determine_driver}) {
111 $_[0]->_determine_driver;
113 # This for some reason crashes and burns on perl 5.8.1
114 # IFF the method ends up throwing an exception
115 #goto $_[0]->can ($meth);
117 my $cref = $_[0]->can ($meth);
127 DBIx::Class::Storage::DBI - DBI storage handler
131 my $schema = MySchema->connect('dbi:SQLite:my.db');
133 $schema->storage->debug(1);
135 my @stuff = $schema->storage->dbh_do(
137 my ($storage, $dbh, @args) = @_;
138 $dbh->do("DROP TABLE authors");
143 $schema->resultset('Book')->search({
144 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
149 This class represents the connection to an RDBMS via L<DBI>. See
150 L<DBIx::Class::Storage> for general information. This pod only
151 documents DBI-specific methods and behaviors.
158 my $new = shift->next::method(@_);
160 $new->transaction_depth(0);
161 $new->_sql_maker_opts({});
162 $new->_dbh_details({});
163 $new->{savepoints} = [];
164 $new->{_in_dbh_do} = 0;
165 $new->{_dbh_gen} = 0;
167 # read below to see what this does
168 $new->_arm_global_destructor;
173 # This is hack to work around perl shooting stuff in random
174 # order on exit(). If we do not walk the remaining storage
175 # objects in an END block, there is a *small but real* chance
176 # of a fork()ed child to kill the parent's shared DBI handle,
177 # *before perl reaches the DESTROY in this package*
178 # Yes, it is ugly and effective.
179 # Additionally this registry is used by the CLONE method to
180 # make sure no handles are shared between threads
182 my %seek_and_destroy;
184 sub _arm_global_destructor {
186 my $key = refaddr ($self);
187 $seek_and_destroy{$key} = $self;
188 weaken ($seek_and_destroy{$key});
192 local $?; # just in case the DBI destructor changes it somehow
194 # destroy just the object if not native to this process/thread
195 $_->_verify_pid for (grep
197 values %seek_and_destroy
202 # As per DBI's recommendation, DBIC disconnects all handles as
203 # soon as possible (DBIC will reconnect only on demand from within
205 for (values %seek_and_destroy) {
207 $_->{_dbh_gen}++; # so that existing cursors will drop as well
216 # some databases spew warnings on implicit disconnect
217 local $SIG{__WARN__} = sub {};
220 # this op is necessary, since the very last perl runtime statement
221 # triggers a global destruction shootout, and the $SIG localization
222 # may very well be destroyed before perl actually gets to do the
227 # handle pid changes correctly - do not destroy parent's connection
231 my $pid = $self->_conn_pid;
232 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
233 $dbh->{InactiveDestroy} = 1;
243 This method is normally called by L<DBIx::Class::Schema/connection>, which
244 encapsulates its argument list in an arrayref before passing them here.
246 The argument list may contain:
252 The same 4-element argument set one would normally pass to
253 L<DBI/connect>, optionally followed by
254 L<extra attributes|/DBIx::Class specific connection attributes>
255 recognized by DBIx::Class:
257 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
261 A single code reference which returns a connected
262 L<DBI database handle|DBI/connect> optionally followed by
263 L<extra attributes|/DBIx::Class specific connection attributes> recognized
266 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
270 A single hashref with all the attributes and the dsn/user/password
273 $connect_info_args = [{
281 $connect_info_args = [{
282 dbh_maker => sub { DBI->connect (...) },
287 This is particularly useful for L<Catalyst> based applications, allowing the
288 following config (L<Config::General> style):
293 dsn dbi:mysql:database=test
300 The C<dsn>/C<user>/C<password> combination can be substituted by the
301 C<dbh_maker> key whose value is a coderef that returns a connected
302 L<DBI database handle|DBI/connect>
306 Please note that the L<DBI> docs recommend that you always explicitly
307 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
308 recommends that it be set to I<1>, and that you perform transactions
309 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
310 to I<1> if you do not do explicitly set it to zero. This is the default
311 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
313 =head3 DBIx::Class specific connection attributes
315 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
316 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
317 the following connection options. These options can be mixed in with your other
318 L<DBI> connection attributes, or placed in a separate hashref
319 (C<\%extra_attributes>) as shown above.
321 Every time C<connect_info> is invoked, any previous settings for
322 these options will be cleared before setting the new ones, regardless of
323 whether any options are specified in the new C<connect_info>.
330 Specifies things to do immediately after connecting or re-connecting to
331 the database. Its value may contain:
337 This contains one SQL statement to execute.
339 =item an array reference
341 This contains SQL statements to execute in order. Each element contains
342 a string or a code reference that returns a string.
344 =item a code reference
346 This contains some code to execute. Unlike code references within an
347 array reference, its return value is ignored.
351 =item on_disconnect_do
353 Takes arguments in the same form as L</on_connect_do> and executes them
354 immediately before disconnecting from the database.
356 Note, this only runs if you explicitly call L</disconnect> on the
359 =item on_connect_call
361 A more generalized form of L</on_connect_do> that calls the specified
362 C<connect_call_METHOD> methods in your storage driver.
364 on_connect_do => 'select 1'
368 on_connect_call => [ [ do_sql => 'select 1' ] ]
370 Its values may contain:
376 Will call the C<connect_call_METHOD> method.
378 =item a code reference
380 Will execute C<< $code->($storage) >>
382 =item an array reference
384 Each value can be a method name or code reference.
386 =item an array of arrays
388 For each array, the first item is taken to be the C<connect_call_> method name
389 or code reference, and the rest are parameters to it.
393 Some predefined storage methods you may use:
399 Executes a SQL string or a code reference that returns a SQL string. This is
400 what L</on_connect_do> and L</on_disconnect_do> use.
408 Will execute the scalar as SQL.
412 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
413 attributes hashref and bind values.
415 =item a code reference
417 Will execute C<< $code->($storage) >> and execute the return array refs as
424 Execute any statements necessary to initialize the database session to return
425 and accept datetime/timestamp values used with
426 L<DBIx::Class::InflateColumn::DateTime>.
428 Only necessary for some databases, see your specific storage driver for
429 implementation details.
433 =item on_disconnect_call
435 Takes arguments in the same form as L</on_connect_call> and executes them
436 immediately before disconnecting from the database.
438 Calls the C<disconnect_call_METHOD> methods as opposed to the
439 C<connect_call_METHOD> methods called by L</on_connect_call>.
441 Note, this only runs if you explicitly call L</disconnect> on the
444 =item disable_sth_caching
446 If set to a true value, this option will disable the caching of
447 statement handles via L<DBI/prepare_cached>.
451 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
452 default L</sql_limit_dialect> setting of the storage (if any). For a list
453 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
457 When true automatically sets L</quote_char> and L</name_sep> to the characters
458 appropriate for your particular RDBMS. This option is preferred over specifying
459 L</quote_char> directly.
463 Specifies what characters to use to quote table and column names.
465 C<quote_char> expects either a single character, in which case is it
466 is placed on either side of the table/column name, or an arrayref of length
467 2 in which case the table/column name is placed between the elements.
469 For example under MySQL you should use C<< quote_char => '`' >>, and for
470 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
474 This parameter is only useful in conjunction with C<quote_char>, and is used to
475 specify the character that separates elements (schemas, tables, columns) from
476 each other. If unspecified it defaults to the most commonly used C<.>.
480 This Storage driver normally installs its own C<HandleError>, sets
481 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
482 all database handles, including those supplied by a coderef. It does this
483 so that it can have consistent and useful error behavior.
485 If you set this option to a true value, Storage will not do its usual
486 modifications to the database handle's attributes, and instead relies on
487 the settings in your connect_info DBI options (or the values you set in
488 your connection coderef, in the case that you are connecting via coderef).
490 Note that your custom settings can cause Storage to malfunction,
491 especially if you set a C<HandleError> handler that suppresses exceptions
492 and/or disable C<RaiseError>.
496 If this option is true, L<DBIx::Class> will use savepoints when nesting
497 transactions, making it possible to recover from failure in the inner
498 transaction without having to abort all outer transactions.
502 Use this argument to supply a cursor class other than the default
503 L<DBIx::Class::Storage::DBI::Cursor>.
507 Some real-life examples of arguments to L</connect_info> and
508 L<DBIx::Class::Schema/connect>
510 # Simple SQLite connection
511 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
514 ->connect_info([ sub { DBI->connect(...) } ]);
516 # Connect via subref in hashref
518 dbh_maker => sub { DBI->connect(...) },
519 on_connect_do => 'alter session ...',
522 # A bit more complicated
529 { quote_char => q{"} },
533 # Equivalent to the previous example
539 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
543 # Same, but with hashref as argument
544 # See parse_connect_info for explanation
547 dsn => 'dbi:Pg:dbname=foo',
549 password => 'my_pg_password',
556 # Subref + DBIx::Class-specific connection options
559 sub { DBI->connect(...) },
563 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
564 disable_sth_caching => 1,
574 my ($self, $info) = @_;
576 return $self->_connect_info if !$info;
578 $self->_connect_info($info); # copy for _connect_info
580 $info = $self->_normalize_connect_info($info)
581 if ref $info eq 'ARRAY';
583 for my $storage_opt (keys %{ $info->{storage_options} }) {
584 my $value = $info->{storage_options}{$storage_opt};
586 $self->$storage_opt($value);
589 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
590 # the new set of options
591 $self->_sql_maker(undef);
592 $self->_sql_maker_opts({});
594 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
595 my $value = $info->{sql_maker_options}{$sql_maker_opt};
597 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
601 %{ $self->_default_dbi_connect_attributes || {} },
602 %{ $info->{attributes} || {} },
605 my @args = @{ $info->{arguments} };
607 if (keys %attrs and ref $args[0] ne 'CODE') {
609 'You provided explicit AutoCommit => 0 in your connection_info. '
610 . 'This is almost universally a bad idea (see the footnotes of '
611 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
612 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
614 if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
616 push @args, \%attrs if keys %attrs;
618 $self->_dbi_connect_info(\@args);
621 # save attributes them in a separate accessor so they are always
622 # introspectable, even in case of a CODE $dbhmaker
623 $self->_dbic_connect_attributes (\%attrs);
625 return $self->_connect_info;
628 sub _normalize_connect_info {
629 my ($self, $info_arg) = @_;
632 my @args = @$info_arg; # take a shallow copy for further mutilation
634 # combine/pre-parse arguments depending on invocation style
637 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
638 %attrs = %{ $args[1] || {} };
641 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
642 %attrs = %{$args[0]};
644 if (my $code = delete $attrs{dbh_maker}) {
647 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
650 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
651 . "to the result of 'dbh_maker'",
653 join (', ', map { "'$_'" } (@ignored) ),
658 @args = delete @attrs{qw/dsn user password/};
661 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
663 % { $args[3] || {} },
664 % { $args[4] || {} },
666 @args = @args[0,1,2];
669 $info{arguments} = \@args;
671 my @storage_opts = grep exists $attrs{$_},
672 @storage_options, 'cursor_class';
674 @{ $info{storage_options} }{@storage_opts} =
675 delete @attrs{@storage_opts} if @storage_opts;
677 my @sql_maker_opts = grep exists $attrs{$_},
678 qw/limit_dialect quote_char name_sep quote_names/;
680 @{ $info{sql_maker_options} }{@sql_maker_opts} =
681 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
683 $info{attributes} = \%attrs if %attrs;
688 sub _default_dbi_connect_attributes () {
693 ShowErrorStatement => 1,
699 This method is deprecated in favour of setting via L</connect_info>.
703 =head2 on_disconnect_do
705 This method is deprecated in favour of setting via L</connect_info>.
709 sub _parse_connect_do {
710 my ($self, $type) = @_;
712 my $val = $self->$type;
713 return () if not defined $val;
718 push @res, [ 'do_sql', $val ];
719 } elsif (ref($val) eq 'CODE') {
721 } elsif (ref($val) eq 'ARRAY') {
722 push @res, map { [ 'do_sql', $_ ] } @$val;
724 $self->throw_exception("Invalid type for $type: ".ref($val));
732 Arguments: ($subref | $method_name), @extra_coderef_args?
734 Execute the given $subref or $method_name using the new exception-based
735 connection management.
737 The first two arguments will be the storage object that C<dbh_do> was called
738 on and a database handle to use. Any additional arguments will be passed
739 verbatim to the called subref as arguments 2 and onwards.
741 Using this (instead of $self->_dbh or $self->dbh) ensures correct
742 exception handling and reconnection (or failover in future subclasses).
744 Your subref should have no side-effects outside of the database, as
745 there is the potential for your subref to be partially double-executed
746 if the database connection was stale/dysfunctional.
750 my @stuff = $schema->storage->dbh_do(
752 my ($storage, $dbh, @cols) = @_;
753 my $cols = join(q{, }, @cols);
754 $dbh->selectrow_array("SELECT $cols FROM foo");
765 my $dbh = $self->_get_dbh;
767 return $self->$code($dbh, @_)
768 if ( $self->{_in_dbh_do} || $self->{transaction_depth} );
770 local $self->{_in_dbh_do} = 1;
772 # take a ref instead of a copy, to preserve coderef @_ aliasing semantics
775 $self->$code ($dbh, @$args);
777 $self->throw_exception($_) if $self->connected;
779 # We were not connected - reconnect and retry, but let any
780 # exception fall right through this time
781 carp "Retrying $code after catching disconnected exception: $_"
782 if $ENV{DBIC_DBIRETRY_DEBUG};
784 $self->_populate_dbh;
785 $self->$code($self->_dbh, @$args);
789 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
790 # It also informs dbh_do to bypass itself while under the direction of txn_do,
791 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
796 ref $coderef eq 'CODE' or $self->throw_exception
797 ('$coderef must be a CODE reference');
799 local $self->{_in_dbh_do} = 1;
802 my $want = wantarray;
808 # take a ref instead of a copy, to preserve coderef @_ aliasing semantics
813 my $txn_start_depth = $self->transaction_depth;
815 @result = $coderef->(@$args);
817 elsif(defined $want) {
818 $result[0] = $coderef->(@$args);
824 my $delta_txn = $txn_start_depth - $self->transaction_depth;
825 if ($delta_txn == 0) {
828 elsif ($delta_txn != 1) {
829 # an off-by-one would mean we fired a rollback
830 carp "Unexpected reduction of transaction depth by $delta_txn after execution of $coderef";
836 if(! defined $exception) { return wantarray ? @result : $result[0] }
838 if($self->transaction_depth > 1 || $tried++ || $self->connected) {
839 my $rollback_exception;
840 try { $self->txn_rollback } catch { $rollback_exception = shift };
841 if(defined $rollback_exception) {
842 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
843 $self->throw_exception($exception) # propagate nested rollback
844 if $rollback_exception =~ /$exception_class/;
846 $self->throw_exception(
847 "Transaction aborted: ${exception}. "
848 . "Rollback failed: ${rollback_exception}"
851 $self->throw_exception($exception)
854 # We were not connected, and was first try - reconnect and retry
856 carp "Retrying $coderef after catching disconnected exception: $exception"
857 if $ENV{DBIC_TXNRETRY_DEBUG};
858 $self->_populate_dbh;
864 Our C<disconnect> method also performs a rollback first if the
865 database is not in C<AutoCommit> mode.
875 push @actions, ( $self->on_disconnect_call || () );
876 push @actions, $self->_parse_connect_do ('on_disconnect_do');
878 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
880 $self->_dbh_rollback unless $self->_dbh_autocommit;
882 %{ $self->_dbh->{CachedKids} } = ();
883 $self->_dbh->disconnect;
889 =head2 with_deferred_fk_checks
893 =item Arguments: C<$coderef>
895 =item Return Value: The return value of $coderef
899 Storage specific method to run the code ref with FK checks deferred or
900 in MySQL's case disabled entirely.
904 # Storage subclasses should override this
905 sub with_deferred_fk_checks {
906 my ($self, $sub) = @_;
914 =item Arguments: none
916 =item Return Value: 1|0
920 Verifies that the current database handle is active and ready to execute
921 an SQL statement (e.g. the connection did not get stale, server is still
922 answering, etc.) This method is used internally by L</dbh>.
928 return 0 unless $self->_seems_connected;
931 local $self->_dbh->{RaiseError} = 1;
936 sub _seems_connected {
941 my $dbh = $self->_dbh
944 return $dbh->FETCH('Active');
950 my $dbh = $self->_dbh or return 0;
955 sub ensure_connected {
958 unless ($self->connected) {
959 $self->_populate_dbh;
965 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
966 is guaranteed to be healthy by implicitly calling L</connected>, and if
967 necessary performing a reconnection before returning. Keep in mind that this
968 is very B<expensive> on some database engines. Consider using L</dbh_do>
976 if (not $self->_dbh) {
977 $self->_populate_dbh;
979 $self->ensure_connected;
984 # this is the internal "get dbh or connect (don't check)" method
988 $self->_populate_dbh unless $self->_dbh;
994 unless ($self->_sql_maker) {
995 my $sql_maker_class = $self->sql_maker_class;
996 $self->ensure_class_loaded ($sql_maker_class);
998 my %opts = %{$self->_sql_maker_opts||{}};
1000 $opts{limit_dialect}
1002 $self->sql_limit_dialect
1005 my $s_class = (ref $self) || $self;
1007 "Your storage class ($s_class) does not set sql_limit_dialect and you "
1008 . 'have not supplied an explicit limit_dialect in your connection_info. '
1009 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
1010 . 'databases but can be (and often is) painfully slow. '
1011 . "Please file an RT ticket against '$s_class' ."
1018 my ($quote_char, $name_sep);
1020 if ($opts{quote_names}) {
1021 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
1022 my $s_class = (ref $self) || $self;
1024 "You requested 'quote_names' but your storage class ($s_class) does "
1025 . 'not explicitly define a default sql_quote_char and you have not '
1026 . 'supplied a quote_char as part of your connection_info. DBIC will '
1027 .q{default to the ANSI SQL standard quote '"', which works most of }
1028 . "the time. Please file an RT ticket against '$s_class'."
1034 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
1037 $self->_sql_maker($sql_maker_class->new(
1038 bindtype=>'columns',
1039 array_datatypes => 1,
1040 limit_dialect => $dialect,
1041 ($quote_char ? (quote_char => $quote_char) : ()),
1042 name_sep => ($name_sep || '.'),
1046 return $self->_sql_maker;
1049 # nothing to do by default
1056 my @info = @{$self->_dbi_connect_info || []};
1057 $self->_dbh(undef); # in case ->connected failed we might get sent here
1058 $self->_dbh_details({}); # reset everything we know
1060 $self->_dbh($self->_connect(@info));
1062 $self->_conn_pid($$) if $^O ne 'MSWin32'; # on win32 these are in fact threads
1064 $self->_determine_driver;
1066 # Always set the transaction depth on connect, since
1067 # there is no transaction in progress by definition
1068 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1070 $self->_run_connection_actions unless $self->{_in_determine_driver};
1073 sub _run_connection_actions {
1077 push @actions, ( $self->on_connect_call || () );
1078 push @actions, $self->_parse_connect_do ('on_connect_do');
1080 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1085 sub set_use_dbms_capability {
1086 $_[0]->set_inherited ($_[1], $_[2]);
1089 sub get_use_dbms_capability {
1090 my ($self, $capname) = @_;
1092 my $use = $self->get_inherited ($capname);
1095 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1099 sub set_dbms_capability {
1100 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1103 sub get_dbms_capability {
1104 my ($self, $capname) = @_;
1106 my $cap = $self->_dbh_details->{capability}{$capname};
1108 unless (defined $cap) {
1109 if (my $meth = $self->can ("_determine$capname")) {
1110 $cap = $self->$meth ? 1 : 0;
1116 $self->set_dbms_capability ($capname, $cap);
1126 unless ($info = $self->_dbh_details->{info}) {
1130 my $server_version = try { $self->_get_server_version };
1132 if (defined $server_version) {
1133 $info->{dbms_version} = $server_version;
1135 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1136 my @verparts = split (/\./, $numeric_version);
1142 # consider only up to 3 version parts, iff not more than 3 digits
1144 while (@verparts && @use_parts < 3) {
1145 my $p = shift @verparts;
1147 push @use_parts, $p;
1149 push @use_parts, 0 while @use_parts < 3;
1151 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1155 $self->_dbh_details->{info} = $info;
1161 sub _get_server_version {
1162 shift->_dbh_get_info(18);
1166 my ($self, $info) = @_;
1168 return try { $self->_get_dbh->get_info($info) } || undef;
1171 sub _determine_driver {
1174 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1175 my $started_connected = 0;
1176 local $self->{_in_determine_driver} = 1;
1178 if (ref($self) eq __PACKAGE__) {
1180 if ($self->_dbh) { # we are connected
1181 $driver = $self->_dbh->{Driver}{Name};
1182 $started_connected = 1;
1184 # if connect_info is a CODEREF, we have no choice but to connect
1185 if (ref $self->_dbi_connect_info->[0] &&
1186 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1187 $self->_populate_dbh;
1188 $driver = $self->_dbh->{Driver}{Name};
1191 # try to use dsn to not require being connected, the driver may still
1192 # force a connection in _rebless to determine version
1193 # (dsn may not be supplied at all if all we do is make a mock-schema)
1194 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1195 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1196 $driver ||= $ENV{DBI_DRIVER};
1201 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1202 if ($self->load_optional_class($storage_class)) {
1203 mro::set_mro($storage_class, 'c3');
1204 bless $self, $storage_class;
1210 $self->_driver_determined(1);
1212 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1214 $self->_init; # run driver-specific initializations
1216 $self->_run_connection_actions
1217 if !$started_connected && defined $self->_dbh;
1221 sub _do_connection_actions {
1223 my $method_prefix = shift;
1226 if (not ref($call)) {
1227 my $method = $method_prefix . $call;
1229 } elsif (ref($call) eq 'CODE') {
1231 } elsif (ref($call) eq 'ARRAY') {
1232 if (ref($call->[0]) ne 'ARRAY') {
1233 $self->_do_connection_actions($method_prefix, $_) for @$call;
1235 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1238 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1244 sub connect_call_do_sql {
1246 $self->_do_query(@_);
1249 sub disconnect_call_do_sql {
1251 $self->_do_query(@_);
1254 # override in db-specific backend when necessary
1255 sub connect_call_datetime_setup { 1 }
1258 my ($self, $action) = @_;
1260 if (ref $action eq 'CODE') {
1261 $action = $action->($self);
1262 $self->_do_query($_) foreach @$action;
1265 # Most debuggers expect ($sql, @bind), so we need to exclude
1266 # the attribute hash which is the second argument to $dbh->do
1267 # furthermore the bind values are usually to be presented
1268 # as named arrayref pairs, so wrap those here too
1269 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1270 my $sql = shift @do_args;
1271 my $attrs = shift @do_args;
1272 my @bind = map { [ undef, $_ ] } @do_args;
1274 $self->_query_start($sql, @bind);
1275 $self->_get_dbh->do($sql, $attrs, @do_args);
1276 $self->_query_end($sql, @bind);
1283 my ($self, @info) = @_;
1285 $self->throw_exception("You failed to provide any connection info")
1288 my ($old_connect_via, $dbh);
1290 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1291 $old_connect_via = $DBI::connect_via;
1292 $DBI::connect_via = 'connect';
1296 if(ref $info[0] eq 'CODE') {
1297 $dbh = $info[0]->();
1300 $dbh = DBI->connect(@info);
1307 unless ($self->unsafe) {
1309 $self->throw_exception(
1310 'Refusing clobbering of {HandleError} installed on externally supplied '
1311 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1312 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1314 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1315 # request, or an external handle. Complain and set anyway
1316 unless ($dbh->{RaiseError}) {
1317 carp( ref $info[0] eq 'CODE'
1319 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1320 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1321 .'attribute has been supplied'
1323 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1324 .'unsafe => 1. Toggling RaiseError back to true'
1327 $dbh->{RaiseError} = 1;
1330 # this odd anonymous coderef dereference is in fact really
1331 # necessary to avoid the unwanted effect described in perl5
1334 my $weak_self = $_[0];
1337 # the coderef is blessed so we can distinguish it from externally
1338 # supplied handles (which must be preserved)
1339 $_[1]->{HandleError} = bless sub {
1341 $weak_self->throw_exception("DBI Exception: $_[0]");
1344 # the handler may be invoked by something totally out of
1346 croak ("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1348 }, '__DBIC__DBH__ERROR__HANDLER__';
1353 $self->throw_exception("DBI Connection failed: $_")
1356 $DBI::connect_via = $old_connect_via if $old_connect_via;
1359 $self->_dbh_autocommit($dbh->{AutoCommit});
1364 my ($self, $name) = @_;
1366 $name = $self->_svp_generate_name
1367 unless defined $name;
1369 $self->throw_exception ("You can't use savepoints outside a transaction")
1370 if $self->{transaction_depth} == 0;
1372 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1373 unless $self->can('_svp_begin');
1375 push @{ $self->{savepoints} }, $name;
1377 $self->debugobj->svp_begin($name) if $self->debug;
1379 return $self->_svp_begin($name);
1383 my ($self, $name) = @_;
1385 $self->throw_exception ("You can't use savepoints outside a transaction")
1386 if $self->{transaction_depth} == 0;
1388 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1389 unless $self->can('_svp_release');
1391 if (defined $name) {
1392 $self->throw_exception ("Savepoint '$name' does not exist")
1393 unless grep { $_ eq $name } @{ $self->{savepoints} };
1395 # Dig through the stack until we find the one we are releasing. This keeps
1396 # the stack up to date.
1399 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1401 $name = pop @{ $self->{savepoints} };
1404 $self->debugobj->svp_release($name) if $self->debug;
1406 return $self->_svp_release($name);
1410 my ($self, $name) = @_;
1412 $self->throw_exception ("You can't use savepoints outside a transaction")
1413 if $self->{transaction_depth} == 0;
1415 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1416 unless $self->can('_svp_rollback');
1418 if (defined $name) {
1419 # If they passed us a name, verify that it exists in the stack
1420 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1421 $self->throw_exception("Savepoint '$name' does not exist!");
1424 # Dig through the stack until we find the one we are releasing. This keeps
1425 # the stack up to date.
1426 while(my $s = pop(@{ $self->{savepoints} })) {
1427 last if($s eq $name);
1429 # Add the savepoint back to the stack, as a rollback doesn't remove the
1430 # named savepoint, only everything after it.
1431 push(@{ $self->{savepoints} }, $name);
1433 # We'll assume they want to rollback to the last savepoint
1434 $name = $self->{savepoints}->[-1];
1437 $self->debugobj->svp_rollback($name) if $self->debug;
1439 return $self->_svp_rollback($name);
1442 sub _svp_generate_name {
1444 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1450 # this means we have not yet connected and do not know the AC status
1451 # (e.g. coderef $dbh)
1452 if (! defined $self->_dbh_autocommit) {
1453 $self->ensure_connected;
1455 # otherwise re-connect on pid changes, so
1456 # that the txn_depth is adjusted properly
1457 # the lightweight _get_dbh is good enoug here
1458 # (only superficial handle check, no pings)
1463 if($self->transaction_depth == 0) {
1464 $self->debugobj->txn_begin()
1466 $self->_dbh_begin_work;
1468 elsif ($self->auto_savepoint) {
1471 $self->{transaction_depth}++;
1474 sub _dbh_begin_work {
1477 # if the user is utilizing txn_do - good for him, otherwise we need to
1478 # ensure that the $dbh is healthy on BEGIN.
1479 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1480 # will be replaced by a failure of begin_work itself (which will be
1481 # then retried on reconnect)
1482 if ($self->{_in_dbh_do}) {
1483 $self->_dbh->begin_work;
1485 $self->dbh_do(sub { $_[1]->begin_work });
1491 if (! $self->_dbh) {
1492 $self->throw_exception('cannot COMMIT on a disconnected handle');
1494 elsif ($self->{transaction_depth} == 1) {
1495 $self->debugobj->txn_commit()
1498 $self->{transaction_depth} = 0
1499 if $self->_dbh_autocommit;
1501 elsif($self->{transaction_depth} > 1) {
1502 $self->{transaction_depth}--;
1504 if $self->auto_savepoint;
1506 elsif (! $self->_dbh->FETCH('AutoCommit') ) {
1508 carp "Storage transaction_depth $self->{transaction_depth} does not match "
1509 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1511 $self->debugobj->txn_commit()
1514 $self->{transaction_depth} = 0
1515 if $self->_dbh_autocommit;
1518 $self->throw_exception( 'Refusing to commit without a started transaction' );
1524 my $dbh = $self->_dbh
1525 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1531 my $dbh = $self->_dbh;
1533 if ($self->{transaction_depth} == 1) {
1534 $self->debugobj->txn_rollback()
1536 $self->{transaction_depth} = 0
1537 if $self->_dbh_autocommit;
1538 $self->_dbh_rollback;
1540 elsif($self->{transaction_depth} > 1) {
1541 $self->{transaction_depth}--;
1542 if ($self->auto_savepoint) {
1543 $self->svp_rollback;
1548 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1552 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1554 if ($_ !~ /$exception_class/) {
1555 # ensure that a failed rollback resets the transaction depth
1556 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1559 $self->throw_exception($_)
1565 my $dbh = $self->_dbh
1566 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1570 # This used to be the top-half of _execute. It was split out to make it
1571 # easier to override in NoBindVars without duping the rest. It takes up
1572 # all of _execute's args, and emits $sql, @bind.
1573 sub _prep_for_execute {
1574 my ($self, $op, $extra_bind, $ident, $args) = @_;
1576 if( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
1577 $ident = $ident->from();
1580 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1583 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1585 return ($sql, \@bind);
1589 sub _fix_bind_params {
1590 my ($self, @bind) = @_;
1592 ### Turn @bind from something like this:
1593 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1595 ### ( "'1'", "'1'", "'3'" )
1598 if ( defined( $_ && $_->[1] ) ) {
1599 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1606 my ( $self, $sql, @bind ) = @_;
1608 if ( $self->debug ) {
1609 @bind = $self->_fix_bind_params(@bind);
1611 $self->debugobj->query_start( $sql, @bind );
1616 my ( $self, $sql, @bind ) = @_;
1618 if ( $self->debug ) {
1619 @bind = $self->_fix_bind_params(@bind);
1620 $self->debugobj->query_end( $sql, @bind );
1625 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1627 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1629 $self->_query_start( $sql, @$bind );
1631 my $sth = $self->sth($sql,$op);
1633 my $placeholder_index = 1;
1635 foreach my $bound (@$bind) {
1636 my $attributes = {};
1637 my($column_name, @data) = @$bound;
1639 if ($bind_attributes) {
1640 $attributes = $bind_attributes->{$column_name}
1641 if defined $bind_attributes->{$column_name};
1644 foreach my $data (@data) {
1645 my $ref = ref $data;
1647 if ($ref and overload::Method($data, '""') ) {
1650 elsif ($ref eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1651 $sth->bind_param_inout(
1652 $placeholder_index++,
1654 $self->_max_column_bytesize($ident, $column_name),
1660 $sth->bind_param($placeholder_index++, $data, $attributes);
1664 # Can this fail without throwing an exception anyways???
1665 my $rv = $sth->execute();
1666 $self->throw_exception(
1667 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1670 $self->_query_end( $sql, @$bind );
1672 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1677 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1680 sub _prefetch_autovalues {
1681 my ($self, $source, $to_insert) = @_;
1683 my $colinfo = $source->columns_info;
1686 for my $col (keys %$colinfo) {
1688 $colinfo->{$col}{auto_nextval}
1691 ! exists $to_insert->{$col}
1693 ref $to_insert->{$col} eq 'SCALAR'
1696 $values{$col} = $self->_sequence_fetch(
1698 ( $colinfo->{$col}{sequence} ||=
1699 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1709 my ($self, $source, $to_insert) = @_;
1711 my $prefetched_values = $self->_prefetch_autovalues($source, $to_insert);
1714 $to_insert = { %$to_insert, %$prefetched_values };
1716 # list of primary keys we try to fetch from the database
1717 # both not-exsists and scalarrefs are considered
1719 for ($source->primary_columns) {
1720 $fetch_pks{$_} = scalar keys %fetch_pks # so we can preserve order for prettyness
1721 if ! exists $to_insert->{$_} or ref $to_insert->{$_} eq 'SCALAR';
1724 my ($sqla_opts, @ir_container);
1725 if ($self->_use_insert_returning) {
1727 # retain order as declared in the resultsource
1728 for (sort { $fetch_pks{$a} <=> $fetch_pks{$b} } keys %fetch_pks ) {
1729 push @{$sqla_opts->{returning}}, $_;
1730 $sqla_opts->{returning_container} = \@ir_container
1731 if $self->_use_insert_returning_bound;
1735 my $bind_attributes = $self->source_bind_attributes($source);
1737 my ($rv, $sth) = $self->_execute('insert' => [], $source, $bind_attributes, $to_insert, $sqla_opts);
1741 if (my $retlist = $sqla_opts->{returning}) {
1742 @ir_container = try {
1743 local $SIG{__WARN__} = sub {};
1744 my @r = $sth->fetchrow_array;
1747 } unless @ir_container;
1749 @returned_cols{@$retlist} = @ir_container if @ir_container;
1752 return { %$prefetched_values, %returned_cols };
1756 ## Currently it is assumed that all values passed will be "normal", i.e. not
1757 ## scalar refs, or at least, all the same type as the first set, the statement is
1758 ## only prepped once.
1760 my ($self, $source, $cols, $data) = @_;
1763 @colvalues{@$cols} = (0..$#$cols);
1765 for my $i (0..$#$cols) {
1766 my $first_val = $data->[0][$i];
1767 next unless ref $first_val eq 'SCALAR';
1769 $colvalues{ $cols->[$i] } = $first_val;
1772 # check for bad data and stringify stringifiable objects
1773 my $bad_slice = sub {
1774 my ($msg, $col_idx, $slice_idx) = @_;
1775 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1779 require Data::Dumper::Concise;
1780 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1781 Data::Dumper::Concise::Dumper ({
1782 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1788 for my $datum_idx (0..$#$data) {
1789 my $datum = $data->[$datum_idx];
1791 for my $col_idx (0..$#$cols) {
1792 my $val = $datum->[$col_idx];
1793 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1794 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1796 if ($is_literal_sql) {
1798 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1800 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1801 $bad_slice->("$reftype reference found where literal SQL expected",
1802 $col_idx, $datum_idx);
1804 elsif ($$val ne $$sqla_bind){
1805 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1806 $col_idx, $datum_idx);
1809 elsif (my $reftype = ref $val) {
1811 if (overload::Method($val, '""')) {
1812 $datum->[$col_idx] = "".$val;
1815 $bad_slice->("$reftype reference found where bind expected",
1816 $col_idx, $datum_idx);
1822 my ($sql, $bind) = $self->_prep_for_execute (
1823 'insert', undef, $source, [\%colvalues]
1827 # if the bindlist is empty - make sure all "values" are in fact
1828 # literal scalarrefs. If not the case this means the storage ate
1829 # them away (e.g. the NoBindVars component) and interpolated them
1830 # directly into the SQL. This obviosly can't be good for multi-inserts
1832 $self->throw_exception('Cannot insert_bulk without support for placeholders')
1833 if first { ref $_ ne 'SCALAR' } values %colvalues;
1836 # neither _execute_array, nor _execute_inserts_with_no_binds are
1837 # atomic (even if _execute _array is a single call). Thus a safety
1839 my $guard = $self->txn_scope_guard;
1841 $self->_query_start( $sql, @$bind ? [ dummy => '__BULK_INSERT__' ] : () );
1842 my $sth = $self->sth($sql);
1845 #@bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1846 $self->_execute_array( $source, $sth, $bind, $cols, $data );
1849 # bind_param_array doesn't work if there are no binds
1850 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1854 $self->_query_end( $sql, @$bind ? [ dummy => '__BULK_INSERT__' ] : () );
1858 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1861 sub _execute_array {
1862 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1864 ## This must be an arrayref, else nothing works!
1865 my $tuple_status = [];
1867 ## Get the bind_attributes, if any exist
1868 my $bind_attributes = $self->source_bind_attributes($source);
1870 ## Bind the values and execute
1871 my $placeholder_index = 1;
1873 foreach my $bound (@$bind) {
1875 my $attributes = {};
1876 my ($column_name, $data_index) = @$bound;
1878 if( $bind_attributes ) {
1879 $attributes = $bind_attributes->{$column_name}
1880 if defined $bind_attributes->{$column_name};
1883 my @data = map { $_->[$data_index] } @$data;
1885 $sth->bind_param_array(
1888 (%$attributes ? $attributes : ()),
1890 $placeholder_index++;
1895 $rv = $self->_dbh_execute_array($sth, $tuple_status, @extra);
1901 # Not all DBDs are create equal. Some throw on error, some return
1902 # an undef $rv, and some set $sth->err - try whatever we can
1903 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
1906 ( !defined $rv or $sth->err )
1909 # Statement must finish even if there was an exception.
1914 $err = shift unless defined $err
1919 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1921 $self->throw_exception("Unexpected populate error: $err")
1922 if ($i > $#$tuple_status);
1924 require Data::Dumper::Concise;
1925 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1926 ($tuple_status->[$i][1] || $err),
1927 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
1934 sub _dbh_execute_array {
1935 my ($self, $sth, $tuple_status, @extra) = @_;
1937 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1940 sub _dbh_execute_inserts_with_no_binds {
1941 my ($self, $sth, $count) = @_;
1945 my $dbh = $self->_get_dbh;
1946 local $dbh->{RaiseError} = 1;
1947 local $dbh->{PrintError} = 0;
1949 $sth->execute foreach 1..$count;
1955 # Make sure statement is finished even if there was an exception.
1960 $err = shift unless defined $err;
1963 $self->throw_exception($err) if defined $err;
1969 my ($self, $source, @args) = @_;
1971 my $bind_attrs = $self->source_bind_attributes($source);
1973 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1978 my ($self, $source, @args) = @_;
1980 my $bind_attrs = $self->source_bind_attributes($source);
1982 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1985 # We were sent here because the $rs contains a complex search
1986 # which will require a subquery to select the correct rows
1987 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1989 # Generating a single PK column subquery is trivial and supported
1990 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1991 # Look at _multipk_update_delete()
1992 sub _subq_update_delete {
1994 my ($rs, $op, $values) = @_;
1996 my $rsrc = $rs->result_source;
1998 # quick check if we got a sane rs on our hands
1999 my @pcols = $rsrc->_pri_cols;
2001 my $sel = $rs->_resolved_attrs->{select};
2002 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
2005 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
2007 join ("\x00", sort @$sel )
2009 $self->throw_exception (
2010 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
2017 $op eq 'update' ? $values : (),
2018 { $pcols[0] => { -in => $rs->as_query } },
2023 return $self->_multipk_update_delete (@_);
2027 # ANSI SQL does not provide a reliable way to perform a multicol-PK
2028 # resultset update/delete involving subqueries. So by default resort
2029 # to simple (and inefficient) delete_all style per-row opearations,
2030 # while allowing specific storages to override this with a faster
2033 sub _multipk_update_delete {
2034 return shift->_per_row_update_delete (@_);
2037 # This is the default loop used to delete/update rows for multi PK
2038 # resultsets, and used by mysql exclusively (because it can't do anything
2041 # We do not use $row->$op style queries, because resultset update/delete
2042 # is not expected to cascade (this is what delete_all/update_all is for).
2044 # There should be no race conditions as the entire operation is rolled
2047 sub _per_row_update_delete {
2049 my ($rs, $op, $values) = @_;
2051 my $rsrc = $rs->result_source;
2052 my @pcols = $rsrc->_pri_cols;
2054 my $guard = $self->txn_scope_guard;
2056 # emulate the return value of $sth->execute for non-selects
2057 my $row_cnt = '0E0';
2059 my $subrs_cur = $rs->cursor;
2060 my @all_pk = $subrs_cur->all;
2061 for my $pks ( @all_pk) {
2064 for my $i (0.. $#pcols) {
2065 $cond->{$pcols[$i]} = $pks->[$i];
2070 $op eq 'update' ? $values : (),
2084 $self->_execute($self->_select_args(@_));
2087 sub _select_args_to_query {
2090 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $rs_attrs, $rows, $offset)
2091 # = $self->_select_args($ident, $select, $cond, $attrs);
2092 my ($op, $bind, $ident, $bind_attrs, @args) =
2093 $self->_select_args(@_);
2095 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2096 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
2097 $prepared_bind ||= [];
2100 ? ($sql, $prepared_bind, $bind_attrs)
2101 : \[ "($sql)", @$prepared_bind ]
2106 my ($self, $ident, $select, $where, $attrs) = @_;
2108 my $sql_maker = $self->sql_maker;
2109 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
2116 $rs_alias && $alias2source->{$rs_alias}
2117 ? ( _rsroot_rsrc => $alias2source->{$rs_alias} )
2122 # calculate bind_attrs before possible $ident mangling
2123 my $bind_attrs = {};
2124 for my $alias (keys %$alias2source) {
2125 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
2126 for my $col (keys %$bindtypes) {
2128 my $fqcn = join ('.', $alias, $col);
2129 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
2131 # Unqialified column names are nice, but at the same time can be
2132 # rather ambiguous. What we do here is basically go along with
2133 # the loop, adding an unqualified column slot to $bind_attrs,
2134 # alongside the fully qualified name. As soon as we encounter
2135 # another column by that name (which would imply another table)
2136 # we unset the unqualified slot and never add any info to it
2137 # to avoid erroneous type binding. If this happens the users
2138 # only choice will be to fully qualify his column name
2140 if (exists $bind_attrs->{$col}) {
2141 $bind_attrs->{$col} = {};
2144 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
2149 # Sanity check the attributes (SQLMaker does it too, but
2150 # in case of a software_limit we'll never reach there)
2151 if (defined $attrs->{offset}) {
2152 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2153 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2155 $attrs->{offset} ||= 0;
2157 if (defined $attrs->{rows}) {
2158 $self->throw_exception("The rows attribute must be a positive integer if present")
2159 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2161 elsif ($attrs->{offset}) {
2162 # MySQL actually recommends this approach. I cringe.
2163 $attrs->{rows} = $sql_maker->__max_int;
2168 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
2169 # storage, unless software limit was requested
2172 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
2174 # grouped prefetch (to satisfy group_by == select)
2175 ( $attrs->{group_by}
2177 @{$attrs->{group_by}}
2179 $attrs->{_prefetch_selector_range}
2182 ($ident, $select, $where, $attrs)
2183 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2185 elsif (! $attrs->{software_limit} ) {
2186 push @limit, $attrs->{rows}, $attrs->{offset};
2189 # try to simplify the joinmap further (prune unreferenced type-single joins)
2190 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2193 # This would be the point to deflate anything found in $where
2194 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2195 # expect a row object. And all we have is a resultsource (it is trivial
2196 # to extract deflator coderefs via $alias2source above).
2198 # I don't see a way forward other than changing the way deflators are
2199 # invoked, and that's just bad...
2202 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $attrs, @limit);
2205 # Returns a counting SELECT for a simple count
2206 # query. Abstracted so that a storage could override
2207 # this to { count => 'firstcol' } or whatever makes
2208 # sense as a performance optimization
2210 #my ($self, $source, $rs_attrs) = @_;
2211 return { count => '*' };
2215 sub source_bind_attributes {
2216 my ($self, $source) = @_;
2218 my $bind_attributes;
2220 my $colinfo = $source->columns_info;
2222 for my $col (keys %$colinfo) {
2223 if (my $dt = $colinfo->{$col}{data_type} ) {
2224 $bind_attributes->{$col} = $self->bind_attribute_by_data_type($dt)
2228 return $bind_attributes;
2235 =item Arguments: $ident, $select, $condition, $attrs
2239 Handle a SQL select statement.
2245 my ($ident, $select, $condition, $attrs) = @_;
2246 return $self->cursor_class->new($self, \@_, $attrs);
2251 my ($rv, $sth, @bind) = $self->_select(@_);
2252 my @row = $sth->fetchrow_array;
2253 my @nextrow = $sth->fetchrow_array if @row;
2254 if(@row && @nextrow) {
2255 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2257 # Need to call finish() to work round broken DBDs
2262 =head2 sql_limit_dialect
2264 This is an accessor for the default SQL limit dialect used by a particular
2265 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2266 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2267 see L<DBIx::Class::SQLMaker::LimitDialects>.
2273 =item Arguments: $sql
2277 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2282 my ($self, $dbh, $sql) = @_;
2284 # 3 is the if_active parameter which avoids active sth re-use
2285 my $sth = $self->disable_sth_caching
2286 ? $dbh->prepare($sql)
2287 : $dbh->prepare_cached($sql, {}, 3);
2289 # XXX You would think RaiseError would make this impossible,
2290 # but apparently that's not true :(
2291 $self->throw_exception(
2294 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
2295 .'an exception and/or setting $dbh->errstr',
2297 ? substr($sql, 0, 20) . '...'
2300 'DBD::' . $dbh->{Driver}{Name},
2308 my ($self, $sql) = @_;
2309 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2312 sub _dbh_columns_info_for {
2313 my ($self, $dbh, $table) = @_;
2315 if ($dbh->can('column_info')) {
2319 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2320 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2322 while ( my $info = $sth->fetchrow_hashref() ){
2324 $column_info{data_type} = $info->{TYPE_NAME};
2325 $column_info{size} = $info->{COLUMN_SIZE};
2326 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2327 $column_info{default_value} = $info->{COLUMN_DEF};
2328 my $col_name = $info->{COLUMN_NAME};
2329 $col_name =~ s/^\"(.*)\"$/$1/;
2331 $result{$col_name} = \%column_info;
2336 return \%result if !$caught && scalar keys %result;
2340 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2342 my @columns = @{$sth->{NAME_lc}};
2343 for my $i ( 0 .. $#columns ){
2345 $column_info{data_type} = $sth->{TYPE}->[$i];
2346 $column_info{size} = $sth->{PRECISION}->[$i];
2347 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2349 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2350 $column_info{data_type} = $1;
2351 $column_info{size} = $2;
2354 $result{$columns[$i]} = \%column_info;
2358 foreach my $col (keys %result) {
2359 my $colinfo = $result{$col};
2360 my $type_num = $colinfo->{data_type};
2362 if(defined $type_num && $dbh->can('type_info')) {
2363 my $type_info = $dbh->type_info($type_num);
2364 $type_name = $type_info->{TYPE_NAME} if $type_info;
2365 $colinfo->{data_type} = $type_name if $type_name;
2372 sub columns_info_for {
2373 my ($self, $table) = @_;
2374 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2377 =head2 last_insert_id
2379 Return the row id of the last insert.
2383 sub _dbh_last_insert_id {
2384 my ($self, $dbh, $source, $col) = @_;
2386 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2388 return $id if defined $id;
2390 my $class = ref $self;
2391 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2394 sub last_insert_id {
2396 $self->_dbh_last_insert_id ($self->_dbh, @_);
2399 =head2 _native_data_type
2403 =item Arguments: $type_name
2407 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2408 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2409 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2411 The default implementation returns C<undef>, implement in your Storage driver if
2412 you need this functionality.
2414 Should map types from other databases to the native RDBMS type, for example
2415 C<VARCHAR2> to C<VARCHAR>.
2417 Types with modifiers should map to the underlying data type. For example,
2418 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2420 Composite types should map to the container type, for example
2421 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2425 sub _native_data_type {
2426 #my ($self, $data_type) = @_;
2430 # Check if placeholders are supported at all
2431 sub _determine_supports_placeholders {
2433 my $dbh = $self->_get_dbh;
2435 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2436 # but it is inaccurate more often than not
2438 local $dbh->{PrintError} = 0;
2439 local $dbh->{RaiseError} = 1;
2440 $dbh->do('select ?', {}, 1);
2448 # Check if placeholders bound to non-string types throw exceptions
2450 sub _determine_supports_typeless_placeholders {
2452 my $dbh = $self->_get_dbh;
2455 local $dbh->{PrintError} = 0;
2456 local $dbh->{RaiseError} = 1;
2457 # this specifically tests a bind that is NOT a string
2458 $dbh->do('select 1 where 1 = ?', {}, 1);
2468 Returns the database driver name.
2473 shift->_get_dbh->{Driver}->{Name};
2476 =head2 bind_attribute_by_data_type
2478 Given a datatype from column info, returns a database specific bind
2479 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2480 let the database planner just handle it.
2482 Generally only needed for special case column types, like bytea in postgres.
2486 sub bind_attribute_by_data_type {
2490 =head2 is_datatype_numeric
2492 Given a datatype from column_info, returns a boolean value indicating if
2493 the current RDBMS considers it a numeric value. This controls how
2494 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2495 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2496 be performed instead of the usual C<eq>.
2500 sub is_datatype_numeric {
2501 my ($self, $dt) = @_;
2503 return 0 unless $dt;
2505 return $dt =~ /^ (?:
2506 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2511 =head2 create_ddl_dir
2515 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2519 Creates a SQL file based on the Schema, for each of the specified
2520 database engines in C<\@databases> in the given directory.
2521 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2523 Given a previous version number, this will also create a file containing
2524 the ALTER TABLE statements to transform the previous schema into the
2525 current one. Note that these statements may contain C<DROP TABLE> or
2526 C<DROP COLUMN> statements that can potentially destroy data.
2528 The file names are created using the C<ddl_filename> method below, please
2529 override this method in your schema if you would like a different file
2530 name format. For the ALTER file, the same format is used, replacing
2531 $version in the name with "$preversion-$version".
2533 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2534 The most common value for this would be C<< { add_drop_table => 1 } >>
2535 to have the SQL produced include a C<DROP TABLE> statement for each table
2536 created. For quoting purposes supply C<quote_table_names> and
2537 C<quote_field_names>.
2539 If no arguments are passed, then the following default values are assumed:
2543 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2545 =item version - $schema->schema_version
2547 =item directory - './'
2549 =item preversion - <none>
2553 By default, C<\%sqlt_args> will have
2555 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2557 merged with the hash passed in. To disable any of those features, pass in a
2558 hashref like the following
2560 { ignore_constraint_names => 0, # ... other options }
2563 WARNING: You are strongly advised to check all SQL files created, before applying
2568 sub create_ddl_dir {
2569 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2572 carp "No directory given, using ./\n";
2577 (require File::Path and File::Path::make_path ("$dir")) # make_path does not like objects (i.e. Path::Class::Dir)
2579 $self->throw_exception(
2580 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2584 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2586 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2587 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2589 my $schema_version = $schema->schema_version || '1.x';
2590 $version ||= $schema_version;
2593 add_drop_table => 1,
2594 ignore_constraint_names => 1,
2595 ignore_index_names => 1,
2599 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2600 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2603 my $sqlt = SQL::Translator->new( $sqltargs );
2605 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2606 my $sqlt_schema = $sqlt->translate({ data => $schema })
2607 or $self->throw_exception ($sqlt->error);
2609 foreach my $db (@$databases) {
2611 $sqlt->{schema} = $sqlt_schema;
2612 $sqlt->producer($db);
2615 my $filename = $schema->ddl_filename($db, $version, $dir);
2616 if (-e $filename && ($version eq $schema_version )) {
2617 # if we are dumping the current version, overwrite the DDL
2618 carp "Overwriting existing DDL file - $filename";
2622 my $output = $sqlt->translate;
2624 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2627 if(!open($file, ">$filename")) {
2628 $self->throw_exception("Can't open $filename for writing ($!)");
2631 print $file $output;
2634 next unless ($preversion);
2636 require SQL::Translator::Diff;
2638 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2639 if(!-e $prefilename) {
2640 carp("No previous schema file found ($prefilename)");
2644 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2646 carp("Overwriting existing diff file - $difffile");
2652 my $t = SQL::Translator->new($sqltargs);
2657 or $self->throw_exception ($t->error);
2659 my $out = $t->translate( $prefilename )
2660 or $self->throw_exception ($t->error);
2662 $source_schema = $t->schema;
2664 $source_schema->name( $prefilename )
2665 unless ( $source_schema->name );
2668 # The "new" style of producers have sane normalization and can support
2669 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2670 # And we have to diff parsed SQL against parsed SQL.
2671 my $dest_schema = $sqlt_schema;
2673 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2674 my $t = SQL::Translator->new($sqltargs);
2679 or $self->throw_exception ($t->error);
2681 my $out = $t->translate( $filename )
2682 or $self->throw_exception ($t->error);
2684 $dest_schema = $t->schema;
2686 $dest_schema->name( $filename )
2687 unless $dest_schema->name;
2690 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2694 if(!open $file, ">$difffile") {
2695 $self->throw_exception("Can't write to $difffile ($!)");
2703 =head2 deployment_statements
2707 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2711 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2713 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2714 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2716 C<$directory> is used to return statements from files in a previously created
2717 L</create_ddl_dir> directory and is optional. The filenames are constructed
2718 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2720 If no C<$directory> is specified then the statements are constructed on the
2721 fly using L<SQL::Translator> and C<$version> is ignored.
2723 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2727 sub deployment_statements {
2728 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2729 $type ||= $self->sqlt_type;
2730 $version ||= $schema->schema_version || '1.x';
2732 my $filename = $schema->ddl_filename($type, $version, $dir);
2735 # FIXME replace this block when a proper sane sql parser is available
2737 open($file, "<$filename")
2738 or $self->throw_exception("Can't open $filename ($!)");
2741 return join('', @rows);
2744 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2745 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2748 # sources needs to be a parser arg, but for simplicty allow at top level
2750 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2751 if exists $sqltargs->{sources};
2753 my $tr = SQL::Translator->new(
2754 producer => "SQL::Translator::Producer::${type}",
2756 parser => 'SQL::Translator::Parser::DBIx::Class',
2762 @ret = $tr->translate;
2765 $ret[0] = $tr->translate;
2768 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2769 unless (@ret && defined $ret[0]);
2771 return wantarray ? @ret : $ret[0];
2774 # FIXME deploy() currently does not accurately report sql errors
2775 # Will always return true while errors are warned
2777 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2781 return if($line =~ /^--/);
2782 # next if($line =~ /^DROP/m);
2783 return if($line =~ /^BEGIN TRANSACTION/m);
2784 return if($line =~ /^COMMIT/m);
2785 return if $line =~ /^\s+$/; # skip whitespace only
2786 $self->_query_start($line);
2788 # do a dbh_do cycle here, as we need some error checking in
2789 # place (even though we will ignore errors)
2790 $self->dbh_do (sub { $_[1]->do($line) });
2792 carp qq{$_ (running "${line}")};
2794 $self->_query_end($line);
2796 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2797 if (@statements > 1) {
2798 foreach my $statement (@statements) {
2799 $deploy->( $statement );
2802 elsif (@statements == 1) {
2803 # split on single line comments and end of statements
2804 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
2810 =head2 datetime_parser
2812 Returns the datetime parser class
2816 sub datetime_parser {
2818 return $self->{datetime_parser} ||= do {
2819 $self->build_datetime_parser(@_);
2823 =head2 datetime_parser_type
2825 Defines (returns) the datetime parser class - currently hardwired to
2826 L<DateTime::Format::MySQL>
2830 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2832 =head2 build_datetime_parser
2834 See L</datetime_parser>
2838 sub build_datetime_parser {
2840 my $type = $self->datetime_parser_type(@_);
2841 $self->ensure_class_loaded ($type);
2846 =head2 is_replicating
2848 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2849 replicate from a master database. Default is undef, which is the result
2850 returned by databases that don't support replication.
2854 sub is_replicating {
2859 =head2 lag_behind_master
2861 Returns a number that represents a certain amount of lag behind a master db
2862 when a given storage is replicating. The number is database dependent, but
2863 starts at zero and increases with the amount of lag. Default in undef
2867 sub lag_behind_master {
2871 =head2 relname_to_table_alias
2875 =item Arguments: $relname, $join_count
2879 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2882 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2883 way these aliases are named.
2885 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2886 otherwise C<"$relname">.
2890 sub relname_to_table_alias {
2891 my ($self, $relname, $join_count) = @_;
2893 my $alias = ($join_count && $join_count > 1 ?
2894 join('_', $relname, $join_count) : $relname);
2899 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
2900 # version and it may be necessary to amend or override it for a specific storage
2901 # if such binds are necessary.
2902 sub _max_column_bytesize {
2903 my ($self, $source, $col) = @_;
2905 my $inf = $source->column_info($col);
2906 return $inf->{_max_bytesize} ||= do {
2910 if (my $data_type = $inf->{data_type}) {
2911 $data_type = lc($data_type);
2913 # String/sized-binary types
2914 if ($data_type =~ /^(?:l?(?:var)?char(?:acter)?(?:\s*varying)?
2915 |(?:var)?binary(?:\s*varying)?|raw)\b/x
2917 $max_size = $inf->{size};
2919 # Other charset/unicode types, assume scale of 4
2920 elsif ($data_type =~ /^(?:national\s*character(?:\s*varying)?|nchar
2924 $max_size = $inf->{size} * 4 if $inf->{size};
2927 elsif ($self->_is_lob_type($data_type)) {
2928 # default to longreadlen
2931 $max_size = 100; # for all other (numeric?) datatypes
2935 $max_size ||= $self->_get_dbh->{LongReadLen} || 8000;
2939 # Determine if a data_type is some type of BLOB
2940 # FIXME: these regexes are expensive, result of these checks should be cached in
2943 my ($self, $data_type) = @_;
2944 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
2945 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
2946 |varchar|character\s*varying|nvarchar
2947 |national\s*character\s*varying))?\z/xi);
2950 sub _is_binary_lob_type {
2951 my ($self, $data_type) = @_;
2952 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
2953 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
2956 sub _is_text_lob_type {
2957 my ($self, $data_type) = @_;
2958 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
2959 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
2960 |national\s*character\s*varying))\z/xi);
2967 =head2 DBIx::Class and AutoCommit
2969 DBIx::Class can do some wonderful magic with handling exceptions,
2970 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2971 (the default) combined with C<txn_do> for transaction support.
2973 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2974 in an assumed transaction between commits, and you're telling us you'd
2975 like to manage that manually. A lot of the magic protections offered by
2976 this module will go away. We can't protect you from exceptions due to database
2977 disconnects because we don't know anything about how to restart your
2978 transactions. You're on your own for handling all sorts of exceptional
2979 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2985 Matt S. Trout <mst@shadowcatsystems.co.uk>
2987 Andy Grundman <andy@hybridized.org>
2991 You may distribute this code under the same terms as Perl itself.