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';
17 use Data::Compare (); # no imports!!! guard against insane architecture
20 # default cursor class, overridable in connect_info attributes
21 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
23 __PACKAGE__->mk_group_accessors('inherited' => qw/
24 sql_limit_dialect sql_quote_char sql_name_sep
27 __PACKAGE__->mk_group_accessors('component_class' => qw/sql_maker_class datetime_parser_type/);
29 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
30 __PACKAGE__->datetime_parser_type('DateTime::Format::MySQL'); # historic default
32 __PACKAGE__->sql_name_sep('.');
34 __PACKAGE__->mk_group_accessors('simple' => qw/
35 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
36 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts _dbh_autocommit
39 # the values for these accessors are picked out (and deleted) from
40 # the attribute hashref passed to connect_info
41 my @storage_options = qw/
42 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
43 disable_sth_caching unsafe auto_savepoint
45 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
48 # capability definitions, using a 2-tiered accessor system
51 # A driver/user may define _use_X, which blindly without any checks says:
52 # "(do not) use this capability", (use_dbms_capability is an "inherited"
55 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
56 # accessor, which in turn calls _determine_supports_X, and stores the return
57 # in a special slot on the storage object, which is wiped every time a $dbh
58 # reconnection takes place (it is not guaranteed that upon reconnection we
59 # will get the same rdbms version). _determine_supports_X does not need to
60 # exist on a driver, as we ->can for it before calling.
62 my @capabilities = (qw/
64 insert_returning_bound
73 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
74 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
76 # on by default, not strictly a capability (pending rewrite)
77 __PACKAGE__->_use_join_optimizer (1);
78 sub _determine_supports_join_optimizer { 1 };
80 # Each of these methods need _determine_driver called before itself
81 # in order to function reliably. This is a purely DRY optimization
83 # get_(use)_dbms_capability need to be called on the correct Storage
84 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
85 # _determine_supports_X which obv. needs a correct driver as well
86 my @rdbms_specific_methods = qw/
100 with_deferred_fk_checks
102 get_use_dbms_capability
109 for my $meth (@rdbms_specific_methods) {
111 my $orig = __PACKAGE__->can ($meth)
112 or die "$meth is not a ::Storage::DBI method!";
115 no warnings qw/redefine/;
116 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
118 # only fire when invoked on an instance, a valid class-based invocation
119 # would e.g. be setting a default for an inherited accessor
122 ! $_[0]->_driver_determined
124 ! $_[0]->{_in_determine_driver}
126 $_[0]->_determine_driver;
128 # This for some reason crashes and burns on perl 5.8.1
129 # IFF the method ends up throwing an exception
130 #goto $_[0]->can ($meth);
132 my $cref = $_[0]->can ($meth);
142 DBIx::Class::Storage::DBI - DBI storage handler
146 my $schema = MySchema->connect('dbi:SQLite:my.db');
148 $schema->storage->debug(1);
150 my @stuff = $schema->storage->dbh_do(
152 my ($storage, $dbh, @args) = @_;
153 $dbh->do("DROP TABLE authors");
158 $schema->resultset('Book')->search({
159 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
164 This class represents the connection to an RDBMS via L<DBI>. See
165 L<DBIx::Class::Storage> for general information. This pod only
166 documents DBI-specific methods and behaviors.
173 my $new = shift->next::method(@_);
175 $new->_sql_maker_opts({});
176 $new->_dbh_details({});
177 $new->{_in_do_block} = 0;
178 $new->{_dbh_gen} = 0;
180 # read below to see what this does
181 $new->_arm_global_destructor;
186 # This is hack to work around perl shooting stuff in random
187 # order on exit(). If we do not walk the remaining storage
188 # objects in an END block, there is a *small but real* chance
189 # of a fork()ed child to kill the parent's shared DBI handle,
190 # *before perl reaches the DESTROY in this package*
191 # Yes, it is ugly and effective.
192 # Additionally this registry is used by the CLONE method to
193 # make sure no handles are shared between threads
195 my %seek_and_destroy;
197 sub _arm_global_destructor {
199 my $key = refaddr ($self);
200 $seek_and_destroy{$key} = $self;
201 weaken ($seek_and_destroy{$key});
205 local $?; # just in case the DBI destructor changes it somehow
207 # destroy just the object if not native to this process/thread
208 $_->_verify_pid for (grep
210 values %seek_and_destroy
215 # As per DBI's recommendation, DBIC disconnects all handles as
216 # soon as possible (DBIC will reconnect only on demand from within
218 for (values %seek_and_destroy) {
220 $_->{_dbh_gen}++; # so that existing cursors will drop as well
223 $_->transaction_depth(0);
232 # some databases spew warnings on implicit disconnect
233 local $SIG{__WARN__} = sub {};
236 # this op is necessary, since the very last perl runtime statement
237 # triggers a global destruction shootout, and the $SIG localization
238 # may very well be destroyed before perl actually gets to do the
243 # handle pid changes correctly - do not destroy parent's connection
247 my $pid = $self->_conn_pid;
248 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
249 $dbh->{InactiveDestroy} = 1;
252 $self->transaction_depth(0);
253 $self->savepoints([]);
261 This method is normally called by L<DBIx::Class::Schema/connection>, which
262 encapsulates its argument list in an arrayref before passing them here.
264 The argument list may contain:
270 The same 4-element argument set one would normally pass to
271 L<DBI/connect>, optionally followed by
272 L<extra attributes|/DBIx::Class specific connection attributes>
273 recognized by DBIx::Class:
275 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
279 A single code reference which returns a connected
280 L<DBI database handle|DBI/connect> optionally followed by
281 L<extra attributes|/DBIx::Class specific connection attributes> recognized
284 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
288 A single hashref with all the attributes and the dsn/user/password
291 $connect_info_args = [{
299 $connect_info_args = [{
300 dbh_maker => sub { DBI->connect (...) },
305 This is particularly useful for L<Catalyst> based applications, allowing the
306 following config (L<Config::General> style):
311 dsn dbi:mysql:database=test
318 The C<dsn>/C<user>/C<password> combination can be substituted by the
319 C<dbh_maker> key whose value is a coderef that returns a connected
320 L<DBI database handle|DBI/connect>
324 Please note that the L<DBI> docs recommend that you always explicitly
325 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
326 recommends that it be set to I<1>, and that you perform transactions
327 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
328 to I<1> if you do not do explicitly set it to zero. This is the default
329 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
331 =head3 DBIx::Class specific connection attributes
333 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
334 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
335 the following connection options. These options can be mixed in with your other
336 L<DBI> connection attributes, or placed in a separate hashref
337 (C<\%extra_attributes>) as shown above.
339 Every time C<connect_info> is invoked, any previous settings for
340 these options will be cleared before setting the new ones, regardless of
341 whether any options are specified in the new C<connect_info>.
348 Specifies things to do immediately after connecting or re-connecting to
349 the database. Its value may contain:
355 This contains one SQL statement to execute.
357 =item an array reference
359 This contains SQL statements to execute in order. Each element contains
360 a string or a code reference that returns a string.
362 =item a code reference
364 This contains some code to execute. Unlike code references within an
365 array reference, its return value is ignored.
369 =item on_disconnect_do
371 Takes arguments in the same form as L</on_connect_do> and executes them
372 immediately before disconnecting from the database.
374 Note, this only runs if you explicitly call L</disconnect> on the
377 =item on_connect_call
379 A more generalized form of L</on_connect_do> that calls the specified
380 C<connect_call_METHOD> methods in your storage driver.
382 on_connect_do => 'select 1'
386 on_connect_call => [ [ do_sql => 'select 1' ] ]
388 Its values may contain:
394 Will call the C<connect_call_METHOD> method.
396 =item a code reference
398 Will execute C<< $code->($storage) >>
400 =item an array reference
402 Each value can be a method name or code reference.
404 =item an array of arrays
406 For each array, the first item is taken to be the C<connect_call_> method name
407 or code reference, and the rest are parameters to it.
411 Some predefined storage methods you may use:
417 Executes a SQL string or a code reference that returns a SQL string. This is
418 what L</on_connect_do> and L</on_disconnect_do> use.
426 Will execute the scalar as SQL.
430 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
431 attributes hashref and bind values.
433 =item a code reference
435 Will execute C<< $code->($storage) >> and execute the return array refs as
442 Execute any statements necessary to initialize the database session to return
443 and accept datetime/timestamp values used with
444 L<DBIx::Class::InflateColumn::DateTime>.
446 Only necessary for some databases, see your specific storage driver for
447 implementation details.
451 =item on_disconnect_call
453 Takes arguments in the same form as L</on_connect_call> and executes them
454 immediately before disconnecting from the database.
456 Calls the C<disconnect_call_METHOD> methods as opposed to the
457 C<connect_call_METHOD> methods called by L</on_connect_call>.
459 Note, this only runs if you explicitly call L</disconnect> on the
462 =item disable_sth_caching
464 If set to a true value, this option will disable the caching of
465 statement handles via L<DBI/prepare_cached>.
469 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
470 default L</sql_limit_dialect> setting of the storage (if any). For a list
471 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
475 When true automatically sets L</quote_char> and L</name_sep> to the characters
476 appropriate for your particular RDBMS. This option is preferred over specifying
477 L</quote_char> directly.
481 Specifies what characters to use to quote table and column names.
483 C<quote_char> expects either a single character, in which case is it
484 is placed on either side of the table/column name, or an arrayref of length
485 2 in which case the table/column name is placed between the elements.
487 For example under MySQL you should use C<< quote_char => '`' >>, and for
488 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
492 This parameter is only useful in conjunction with C<quote_char>, and is used to
493 specify the character that separates elements (schemas, tables, columns) from
494 each other. If unspecified it defaults to the most commonly used C<.>.
498 This Storage driver normally installs its own C<HandleError>, sets
499 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
500 all database handles, including those supplied by a coderef. It does this
501 so that it can have consistent and useful error behavior.
503 If you set this option to a true value, Storage will not do its usual
504 modifications to the database handle's attributes, and instead relies on
505 the settings in your connect_info DBI options (or the values you set in
506 your connection coderef, in the case that you are connecting via coderef).
508 Note that your custom settings can cause Storage to malfunction,
509 especially if you set a C<HandleError> handler that suppresses exceptions
510 and/or disable C<RaiseError>.
514 If this option is true, L<DBIx::Class> will use savepoints when nesting
515 transactions, making it possible to recover from failure in the inner
516 transaction without having to abort all outer transactions.
520 Use this argument to supply a cursor class other than the default
521 L<DBIx::Class::Storage::DBI::Cursor>.
525 Some real-life examples of arguments to L</connect_info> and
526 L<DBIx::Class::Schema/connect>
528 # Simple SQLite connection
529 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
532 ->connect_info([ sub { DBI->connect(...) } ]);
534 # Connect via subref in hashref
536 dbh_maker => sub { DBI->connect(...) },
537 on_connect_do => 'alter session ...',
540 # A bit more complicated
547 { quote_char => q{"} },
551 # Equivalent to the previous example
557 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
561 # Same, but with hashref as argument
562 # See parse_connect_info for explanation
565 dsn => 'dbi:Pg:dbname=foo',
567 password => 'my_pg_password',
574 # Subref + DBIx::Class-specific connection options
577 sub { DBI->connect(...) },
581 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
582 disable_sth_caching => 1,
592 my ($self, $info) = @_;
594 return $self->_connect_info if !$info;
596 $self->_connect_info($info); # copy for _connect_info
598 $info = $self->_normalize_connect_info($info)
599 if ref $info eq 'ARRAY';
601 for my $storage_opt (keys %{ $info->{storage_options} }) {
602 my $value = $info->{storage_options}{$storage_opt};
604 $self->$storage_opt($value);
607 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
608 # the new set of options
609 $self->_sql_maker(undef);
610 $self->_sql_maker_opts({});
612 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
613 my $value = $info->{sql_maker_options}{$sql_maker_opt};
615 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
619 %{ $self->_default_dbi_connect_attributes || {} },
620 %{ $info->{attributes} || {} },
623 my @args = @{ $info->{arguments} };
625 if (keys %attrs and ref $args[0] ne 'CODE') {
627 'You provided explicit AutoCommit => 0 in your connection_info. '
628 . 'This is almost universally a bad idea (see the footnotes of '
629 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
630 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
632 if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
634 push @args, \%attrs if keys %attrs;
636 $self->_dbi_connect_info(\@args);
639 # save attributes them in a separate accessor so they are always
640 # introspectable, even in case of a CODE $dbhmaker
641 $self->_dbic_connect_attributes (\%attrs);
643 return $self->_connect_info;
646 sub _normalize_connect_info {
647 my ($self, $info_arg) = @_;
650 my @args = @$info_arg; # take a shallow copy for further mutilation
652 # combine/pre-parse arguments depending on invocation style
655 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
656 %attrs = %{ $args[1] || {} };
659 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
660 %attrs = %{$args[0]};
662 if (my $code = delete $attrs{dbh_maker}) {
665 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
668 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
669 . "to the result of 'dbh_maker'",
671 join (', ', map { "'$_'" } (@ignored) ),
676 @args = delete @attrs{qw/dsn user password/};
679 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
681 % { $args[3] || {} },
682 % { $args[4] || {} },
684 @args = @args[0,1,2];
687 $info{arguments} = \@args;
689 my @storage_opts = grep exists $attrs{$_},
690 @storage_options, 'cursor_class';
692 @{ $info{storage_options} }{@storage_opts} =
693 delete @attrs{@storage_opts} if @storage_opts;
695 my @sql_maker_opts = grep exists $attrs{$_},
696 qw/limit_dialect quote_char name_sep quote_names/;
698 @{ $info{sql_maker_options} }{@sql_maker_opts} =
699 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
701 $info{attributes} = \%attrs if %attrs;
706 sub _default_dbi_connect_attributes () {
711 ShowErrorStatement => 1,
717 This method is deprecated in favour of setting via L</connect_info>.
721 =head2 on_disconnect_do
723 This method is deprecated in favour of setting via L</connect_info>.
727 sub _parse_connect_do {
728 my ($self, $type) = @_;
730 my $val = $self->$type;
731 return () if not defined $val;
736 push @res, [ 'do_sql', $val ];
737 } elsif (ref($val) eq 'CODE') {
739 } elsif (ref($val) eq 'ARRAY') {
740 push @res, map { [ 'do_sql', $_ ] } @$val;
742 $self->throw_exception("Invalid type for $type: ".ref($val));
750 Arguments: ($subref | $method_name), @extra_coderef_args?
752 Execute the given $subref or $method_name using the new exception-based
753 connection management.
755 The first two arguments will be the storage object that C<dbh_do> was called
756 on and a database handle to use. Any additional arguments will be passed
757 verbatim to the called subref as arguments 2 and onwards.
759 Using this (instead of $self->_dbh or $self->dbh) ensures correct
760 exception handling and reconnection (or failover in future subclasses).
762 Your subref should have no side-effects outside of the database, as
763 there is the potential for your subref to be partially double-executed
764 if the database connection was stale/dysfunctional.
768 my @stuff = $schema->storage->dbh_do(
770 my ($storage, $dbh, @cols) = @_;
771 my $cols = join(q{, }, @cols);
772 $dbh->selectrow_array("SELECT $cols FROM foo");
783 my $dbh = $self->_get_dbh;
785 return $self->$code($dbh, @_)
786 if ( $self->{_in_do_block} || $self->{transaction_depth} );
788 local $self->{_in_do_block} = 1;
790 # take a ref instead of a copy, to preserve coderef @_ aliasing semantics
794 $self->$code ($dbh, @$args);
796 $self->throw_exception($_) if $self->connected;
798 # We were not connected - reconnect and retry, but let any
799 # exception fall right through this time
800 carp "Retrying dbh_do($code) after catching disconnected exception: $_"
801 if $ENV{DBIC_STORAGE_RETRY_DEBUG};
803 $self->_populate_dbh;
804 $self->$code($self->_dbh, @$args);
809 # connects or reconnects on pid change, necessary to grab correct txn_depth
811 local $_[0]->{_in_do_block} = 1;
812 shift->next::method(@_);
817 Our C<disconnect> method also performs a rollback first if the
818 database is not in C<AutoCommit> mode.
828 push @actions, ( $self->on_disconnect_call || () );
829 push @actions, $self->_parse_connect_do ('on_disconnect_do');
831 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
833 # stops the "implicit rollback on disconnect" warning
834 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
836 %{ $self->_dbh->{CachedKids} } = ();
837 $self->_dbh->disconnect;
843 =head2 with_deferred_fk_checks
847 =item Arguments: C<$coderef>
849 =item Return Value: The return value of $coderef
853 Storage specific method to run the code ref with FK checks deferred or
854 in MySQL's case disabled entirely.
858 # Storage subclasses should override this
859 sub with_deferred_fk_checks {
860 my ($self, $sub) = @_;
868 =item Arguments: none
870 =item Return Value: 1|0
874 Verifies that the current database handle is active and ready to execute
875 an SQL statement (e.g. the connection did not get stale, server is still
876 answering, etc.) This method is used internally by L</dbh>.
882 return 0 unless $self->_seems_connected;
885 local $self->_dbh->{RaiseError} = 1;
890 sub _seems_connected {
895 my $dbh = $self->_dbh
898 return $dbh->FETCH('Active');
904 my $dbh = $self->_dbh or return 0;
909 sub ensure_connected {
912 unless ($self->connected) {
913 $self->_populate_dbh;
919 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
920 is guaranteed to be healthy by implicitly calling L</connected>, and if
921 necessary performing a reconnection before returning. Keep in mind that this
922 is very B<expensive> on some database engines. Consider using L</dbh_do>
930 if (not $self->_dbh) {
931 $self->_populate_dbh;
933 $self->ensure_connected;
938 # this is the internal "get dbh or connect (don't check)" method
942 $self->_populate_dbh unless $self->_dbh;
948 unless ($self->_sql_maker) {
949 my $sql_maker_class = $self->sql_maker_class;
951 my %opts = %{$self->_sql_maker_opts||{}};
955 $self->sql_limit_dialect
958 my $s_class = (ref $self) || $self;
960 "Your storage class ($s_class) does not set sql_limit_dialect and you "
961 . 'have not supplied an explicit limit_dialect in your connection_info. '
962 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
963 . 'databases but can be (and often is) painfully slow. '
964 . "Please file an RT ticket against '$s_class' ."
971 my ($quote_char, $name_sep);
973 if ($opts{quote_names}) {
974 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
975 my $s_class = (ref $self) || $self;
977 "You requested 'quote_names' but your storage class ($s_class) does "
978 . 'not explicitly define a default sql_quote_char and you have not '
979 . 'supplied a quote_char as part of your connection_info. DBIC will '
980 .q{default to the ANSI SQL standard quote '"', which works most of }
981 . "the time. Please file an RT ticket against '$s_class'."
987 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
990 $self->_sql_maker($sql_maker_class->new(
992 array_datatypes => 1,
993 limit_dialect => $dialect,
994 ($quote_char ? (quote_char => $quote_char) : ()),
995 name_sep => ($name_sep || '.'),
999 return $self->_sql_maker;
1002 # nothing to do by default
1009 my @info = @{$self->_dbi_connect_info || []};
1010 $self->_dbh(undef); # in case ->connected failed we might get sent here
1011 $self->_dbh_details({}); # reset everything we know
1013 $self->_dbh($self->_connect(@info));
1015 $self->_conn_pid($$) if $^O ne 'MSWin32'; # on win32 these are in fact threads
1017 $self->_determine_driver;
1019 # Always set the transaction depth on connect, since
1020 # there is no transaction in progress by definition
1021 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1023 $self->_run_connection_actions unless $self->{_in_determine_driver};
1026 sub _run_connection_actions {
1030 push @actions, ( $self->on_connect_call || () );
1031 push @actions, $self->_parse_connect_do ('on_connect_do');
1033 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1038 sub set_use_dbms_capability {
1039 $_[0]->set_inherited ($_[1], $_[2]);
1042 sub get_use_dbms_capability {
1043 my ($self, $capname) = @_;
1045 my $use = $self->get_inherited ($capname);
1048 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1052 sub set_dbms_capability {
1053 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1056 sub get_dbms_capability {
1057 my ($self, $capname) = @_;
1059 my $cap = $self->_dbh_details->{capability}{$capname};
1061 unless (defined $cap) {
1062 if (my $meth = $self->can ("_determine$capname")) {
1063 $cap = $self->$meth ? 1 : 0;
1069 $self->set_dbms_capability ($capname, $cap);
1079 unless ($info = $self->_dbh_details->{info}) {
1083 my $server_version = try { $self->_get_server_version };
1085 if (defined $server_version) {
1086 $info->{dbms_version} = $server_version;
1088 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1089 my @verparts = split (/\./, $numeric_version);
1095 # consider only up to 3 version parts, iff not more than 3 digits
1097 while (@verparts && @use_parts < 3) {
1098 my $p = shift @verparts;
1100 push @use_parts, $p;
1102 push @use_parts, 0 while @use_parts < 3;
1104 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1108 $self->_dbh_details->{info} = $info;
1114 sub _get_server_version {
1115 shift->_dbh_get_info(18);
1119 my ($self, $info) = @_;
1121 return try { $self->_get_dbh->get_info($info) } || undef;
1124 sub _determine_driver {
1127 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1128 my $started_connected = 0;
1129 local $self->{_in_determine_driver} = 1;
1131 if (ref($self) eq __PACKAGE__) {
1133 if ($self->_dbh) { # we are connected
1134 $driver = $self->_dbh->{Driver}{Name};
1135 $started_connected = 1;
1137 # if connect_info is a CODEREF, we have no choice but to connect
1138 if (ref $self->_dbi_connect_info->[0] &&
1139 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1140 $self->_populate_dbh;
1141 $driver = $self->_dbh->{Driver}{Name};
1144 # try to use dsn to not require being connected, the driver may still
1145 # force a connection in _rebless to determine version
1146 # (dsn may not be supplied at all if all we do is make a mock-schema)
1147 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1148 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1149 $driver ||= $ENV{DBI_DRIVER};
1154 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1155 if ($self->load_optional_class($storage_class)) {
1156 mro::set_mro($storage_class, 'c3');
1157 bless $self, $storage_class;
1163 $self->_driver_determined(1);
1165 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1167 $self->_init; # run driver-specific initializations
1169 $self->_run_connection_actions
1170 if !$started_connected && defined $self->_dbh;
1174 sub _do_connection_actions {
1176 my $method_prefix = shift;
1179 if (not ref($call)) {
1180 my $method = $method_prefix . $call;
1182 } elsif (ref($call) eq 'CODE') {
1184 } elsif (ref($call) eq 'ARRAY') {
1185 if (ref($call->[0]) ne 'ARRAY') {
1186 $self->_do_connection_actions($method_prefix, $_) for @$call;
1188 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1191 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1197 sub connect_call_do_sql {
1199 $self->_do_query(@_);
1202 sub disconnect_call_do_sql {
1204 $self->_do_query(@_);
1207 # override in db-specific backend when necessary
1208 sub connect_call_datetime_setup { 1 }
1211 my ($self, $action) = @_;
1213 if (ref $action eq 'CODE') {
1214 $action = $action->($self);
1215 $self->_do_query($_) foreach @$action;
1218 # Most debuggers expect ($sql, @bind), so we need to exclude
1219 # the attribute hash which is the second argument to $dbh->do
1220 # furthermore the bind values are usually to be presented
1221 # as named arrayref pairs, so wrap those here too
1222 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1223 my $sql = shift @do_args;
1224 my $attrs = shift @do_args;
1225 my @bind = map { [ undef, $_ ] } @do_args;
1227 $self->_query_start($sql, \@bind);
1228 $self->_get_dbh->do($sql, $attrs, @do_args);
1229 $self->_query_end($sql, \@bind);
1236 my ($self, @info) = @_;
1238 $self->throw_exception("You failed to provide any connection info")
1241 my ($old_connect_via, $dbh);
1243 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1244 $old_connect_via = $DBI::connect_via;
1245 $DBI::connect_via = 'connect';
1249 if(ref $info[0] eq 'CODE') {
1250 $dbh = $info[0]->();
1254 $dbh = DBI->connect(@info);
1261 unless ($self->unsafe) {
1263 $self->throw_exception(
1264 'Refusing clobbering of {HandleError} installed on externally supplied '
1265 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1266 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1268 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1269 # request, or an external handle. Complain and set anyway
1270 unless ($dbh->{RaiseError}) {
1271 carp( ref $info[0] eq 'CODE'
1273 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1274 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1275 .'attribute has been supplied'
1277 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1278 .'unsafe => 1. Toggling RaiseError back to true'
1281 $dbh->{RaiseError} = 1;
1284 # this odd anonymous coderef dereference is in fact really
1285 # necessary to avoid the unwanted effect described in perl5
1288 my $weak_self = $_[0];
1291 # the coderef is blessed so we can distinguish it from externally
1292 # supplied handles (which must be preserved)
1293 $_[1]->{HandleError} = bless sub {
1295 $weak_self->throw_exception("DBI Exception: $_[0]");
1298 # the handler may be invoked by something totally out of
1300 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1302 }, '__DBIC__DBH__ERROR__HANDLER__';
1307 $self->throw_exception("DBI Connection failed: $_")
1310 $DBI::connect_via = $old_connect_via if $old_connect_via;
1313 $self->_dbh_autocommit($dbh->{AutoCommit});
1320 # this means we have not yet connected and do not know the AC status
1321 # (e.g. coderef $dbh), need a full-fledged connection check
1322 if (! defined $self->_dbh_autocommit) {
1323 $self->ensure_connected;
1325 # Otherwise simply connect or re-connect on pid changes
1330 $self->next::method(@_);
1333 sub _exec_txn_begin {
1336 # if the user is utilizing txn_do - good for him, otherwise we need to
1337 # ensure that the $dbh is healthy on BEGIN.
1338 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1339 # will be replaced by a failure of begin_work itself (which will be
1340 # then retried on reconnect)
1341 if ($self->{_in_do_block}) {
1342 $self->_dbh->begin_work;
1344 $self->dbh_do(sub { $_[1]->begin_work });
1351 $self->_verify_pid if $self->_dbh;
1352 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1355 # esoteric case for folks using external $dbh handles
1356 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1357 carp "Storage transaction_depth 0 does not match "
1358 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1359 $self->transaction_depth(1);
1362 $self->next::method(@_);
1364 # if AutoCommit is disabled txn_depth never goes to 0
1365 # as a new txn is started immediately on commit
1366 $self->transaction_depth(1) if (
1367 !$self->transaction_depth
1369 defined $self->_dbh_autocommit
1371 ! $self->_dbh_autocommit
1375 sub _exec_txn_commit {
1376 shift->_dbh->commit;
1382 $self->_verify_pid if $self->_dbh;
1383 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1386 # esoteric case for folks using external $dbh handles
1387 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1388 carp "Storage transaction_depth 0 does not match "
1389 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1390 $self->transaction_depth(1);
1393 $self->next::method(@_);
1395 # if AutoCommit is disabled txn_depth never goes to 0
1396 # as a new txn is started immediately on commit
1397 $self->transaction_depth(1) if (
1398 !$self->transaction_depth
1400 defined $self->_dbh_autocommit
1402 ! $self->_dbh_autocommit
1406 sub _exec_txn_rollback {
1407 shift->_dbh->rollback;
1410 # generate some identical methods
1411 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1413 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1415 $self->_verify_pid if $self->_dbh;
1416 $self->throw_exception("Unable to $meth() on a disconnected storage")
1418 $self->next::method(@_);
1422 # This used to be the top-half of _execute. It was split out to make it
1423 # easier to override in NoBindVars without duping the rest. It takes up
1424 # all of _execute's args, and emits $sql, @bind.
1425 sub _prep_for_execute {
1426 #my ($self, $op, $ident, $args) = @_;
1427 return shift->_gen_sql_bind(@_)
1431 my ($self, $op, $ident, $args) = @_;
1433 my ($sql, @bind) = $self->sql_maker->$op(
1434 blessed($ident) ? $ident->from : $ident,
1439 ! $ENV{DBIC_DT_SEARCH_OK}
1443 first { blessed($_->[1]) && $_->[1]->isa('DateTime') } @bind
1445 carp_unique 'DateTime objects passed to search() are not supported '
1446 . 'properly (InflateColumn::DateTime formats and settings are not '
1447 . 'respected.) See "Formatting DateTime objects in queries" in '
1448 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1449 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1452 return( $sql, $self->_resolve_bindattrs(
1453 $ident, [ @{$args->[2]{bind}||[]}, @bind ]
1457 sub _resolve_bindattrs {
1458 my ($self, $ident, $bind, $colinfos) = @_;
1462 my $resolve_bindinfo = sub {
1463 #my $infohash = shift;
1465 %$colinfos = %{ $self->_resolve_column_info($ident) }
1466 unless keys %$colinfos;
1469 if (my $col = $_[0]->{dbic_colname}) {
1470 $ret = { %{$_[0]} };
1472 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1473 if $colinfos->{$col}{data_type};
1475 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1476 if $colinfos->{$col}{size};
1483 if (ref $_ ne 'ARRAY') {
1486 elsif (! defined $_->[0]) {
1489 elsif (ref $_->[0] eq 'HASH') {
1491 ($_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype}) ? $_->[0] : $resolve_bindinfo->($_->[0]),
1495 elsif (ref $_->[0] eq 'SCALAR') {
1496 [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1499 [ $resolve_bindinfo->({ dbic_colname => $_->[0] }), $_->[1] ]
1504 sub _format_for_trace {
1505 #my ($self, $bind) = @_;
1507 ### Turn @bind from something like this:
1508 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1510 ### ( "'1'", "'3'" )
1513 defined( $_ && $_->[1] )
1520 my ( $self, $sql, $bind ) = @_;
1522 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1527 my ( $self, $sql, $bind ) = @_;
1529 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1534 sub _dbi_attrs_for_bind {
1535 my ($self, $ident, $bind) = @_;
1537 if (! defined $sba_compat) {
1538 $self->_determine_driver;
1539 $sba_compat = $self->can('source_bind_attributes') == \&source_bind_attributes
1547 my $class = ref $self;
1549 "The source_bind_attributes() override in $class relies on a deprecated codepath. "
1550 .'You are strongly advised to switch your code to override bind_attribute_by_datatype() '
1551 .'instead. This legacy compat shim will also disappear some time before DBIC 0.09'
1554 my $sba_attrs = $self->source_bind_attributes
1559 for (map { $_->[0] } @$bind) {
1561 if (exists $_->{dbd_attrs}) {
1564 elsif($_->{sqlt_datatype}) {
1565 # cache the result in the dbh_details hash, as it can not change unless
1566 # we connect to something else
1567 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1568 if (not exists $cache->{$_->{sqlt_datatype}}) {
1569 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1571 $cache->{$_->{sqlt_datatype}};
1573 elsif ($sba_attrs and $_->{dbic_colname}) {
1574 $sba_attrs->{$_->{dbic_colname}} || undef;
1577 undef; # always push something at this position
1586 my ($self, $op, $ident, @args) = @_;
1588 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1590 shift->dbh_do( # retry over disconnects
1594 $self->_dbi_attrs_for_bind($ident, $bind)
1599 my ($self, undef, $sql, $bind, $bind_attrs) = @_;
1601 $self->_query_start( $sql, $bind );
1602 my $sth = $self->_sth($sql);
1604 for my $i (0 .. $#$bind) {
1605 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1606 $sth->bind_param_inout(
1607 $i + 1, # bind params counts are 1-based
1609 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1616 (ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""'))
1625 # Can this fail without throwing an exception anyways???
1626 my $rv = $sth->execute();
1627 $self->throw_exception(
1628 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1631 $self->_query_end( $sql, $bind );
1633 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1636 sub _prefetch_autovalues {
1637 my ($self, $source, $to_insert) = @_;
1639 my $colinfo = $source->columns_info;
1642 for my $col (keys %$colinfo) {
1644 $colinfo->{$col}{auto_nextval}
1647 ! exists $to_insert->{$col}
1649 ref $to_insert->{$col} eq 'SCALAR'
1651 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1654 $values{$col} = $self->_sequence_fetch(
1656 ( $colinfo->{$col}{sequence} ||=
1657 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1667 my ($self, $source, $to_insert) = @_;
1669 my $prefetched_values = $self->_prefetch_autovalues($source, $to_insert);
1671 # fuse the values, but keep a separate list of prefetched_values so that
1672 # they can be fused once again with the final return
1673 $to_insert = { %$to_insert, %$prefetched_values };
1675 my $col_infos = $source->columns_info;
1676 my %pcols = map { $_ => 1 } $source->primary_columns;
1678 for my $col ($source->columns) {
1679 # nothing to retrieve when explicit values are supplied
1680 next if (defined $to_insert->{$col} and ! (
1681 ref $to_insert->{$col} eq 'SCALAR'
1683 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1686 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1687 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1690 $col_infos->{$col}{retrieve_on_insert}
1694 my ($sqla_opts, @ir_container);
1695 if (%retrieve_cols and $self->_use_insert_returning) {
1696 $sqla_opts->{returning_container} = \@ir_container
1697 if $self->_use_insert_returning_bound;
1699 $sqla_opts->{returning} = [
1700 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1704 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1706 my %returned_cols = %$to_insert;
1707 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1708 @ir_container = try {
1709 local $SIG{__WARN__} = sub {};
1710 my @r = $sth->fetchrow_array;
1713 } unless @ir_container;
1715 @returned_cols{@$retlist} = @ir_container if @ir_container;
1718 # pull in PK if needed and then everything else
1719 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1721 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1722 unless $self->can('last_insert_id');
1724 my @pri_values = $self->last_insert_id($source, @missing_pri);
1726 $self->throw_exception( "Can't get last insert id" )
1727 unless (@pri_values == @missing_pri);
1729 @returned_cols{@missing_pri} = @pri_values;
1730 delete $retrieve_cols{$_} for @missing_pri;
1733 # if there is more left to pull
1734 if (%retrieve_cols) {
1735 $self->throw_exception(
1736 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1739 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1741 my $cur = DBIx::Class::ResultSet->new($source, {
1742 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
1743 select => \@left_to_fetch,
1746 @returned_cols{@left_to_fetch} = $cur->next;
1748 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
1749 if scalar $cur->next;
1753 return { %$prefetched_values, %returned_cols };
1757 my ($self, $source, $cols, $data) = @_;
1759 my @col_range = (0..$#$cols);
1761 # FIXME - perhaps this is not even needed? does DBI stringify?
1763 # forcibly stringify whatever is stringifiable
1764 # ResultSet::populate() hands us a copy - safe to mangle
1765 for my $r (0 .. $#$data) {
1766 for my $c (0 .. $#{$data->[$r]}) {
1767 $data->[$r][$c] = "$data->[$r][$c]"
1768 if ( ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
1772 my $colinfo_cache = {}; # since we will run _resolve_bindattrs on the same $source a lot
1774 # get a slice type index based on first row of data
1775 # a "column" in this context may refer to more than one bind value
1776 # e.g. \[ '?, ?', [...], [...] ]
1778 # construct the value type index - a description of values types for every
1779 # per-column slice of $data:
1781 # nonexistent - nonbind literal
1783 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
1785 # also construct the column hash to pass to the SQL generator. For plain
1786 # (non literal) values - convert the members of the first row into a
1787 # literal+bind combo, with extra positional info in the bind attr hashref.
1788 # This will allow us to match the order properly, and is so contrived
1789 # because a user-supplied literal/bind (or something else specific to a
1790 # resultsource and/or storage driver) can inject extra binds along the
1791 # way, so one can't rely on "shift positions" ordering at all. Also we
1792 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
1793 # can be later matched up by address), because we want to supply a real
1794 # value on which perhaps e.g. datatype checks will be performed
1795 my ($proto_data, $value_type_idx);
1796 for my $i (@col_range) {
1797 my $colname = $cols->[$i];
1798 if (ref $data->[0][$i] eq 'SCALAR') {
1799 # no bind value at all - no type
1801 $proto_data->{$colname} = $data->[0][$i];
1803 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
1804 # repack, so we don't end up mangling the original \[]
1805 my ($sql, @bind) = @${$data->[0][$i]};
1807 # normalization of user supplied stuff
1808 my $resolved_bind = $self->_resolve_bindattrs(
1809 $source, \@bind, $colinfo_cache,
1812 # store value-less (attrs only) bind info - we will be comparing all
1813 # supplied binds against this for sanity
1814 $value_type_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
1816 $proto_data->{$colname} = \[ $sql, map { [
1817 # inject slice order to use for $proto_bind construction
1818 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i }
1820 $resolved_bind->[$_][1]
1825 $value_type_idx->{$i} = 0;
1827 $proto_data->{$colname} = \[ '?', [
1828 { dbic_colname => $colname, _bind_data_slice_idx => $i }
1835 my ($sql, $proto_bind) = $self->_prep_for_execute (
1841 if (! @$proto_bind and keys %$value_type_idx) {
1842 # if the bindlist is empty and we had some dynamic binds, this means the
1843 # storage ate them away (e.g. the NoBindVars component) and interpolated
1844 # them directly into the SQL. This obviously can't be good for multi-inserts
1845 $self->throw_exception('Cannot insert_bulk without support for placeholders');
1849 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
1851 # use an error reporting closure for convenience (less to pass)
1852 my $bad_slice_report_cref = sub {
1853 my ($msg, $r_idx, $c_idx) = @_;
1854 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1858 require Data::Dumper::Concise;
1859 local $Data::Dumper::Maxdepth = 5;
1860 Data::Dumper::Concise::Dumper ({
1861 map { $cols->[$_] =>
1869 for my $col_idx (@col_range) {
1870 my $reference_val = $data->[0][$col_idx];
1872 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
1873 my $val = $data->[$row_idx][$col_idx];
1875 if (! exists $value_type_idx->{$col_idx}) { # literal no binds
1876 if (ref $val ne 'SCALAR') {
1877 $bad_slice_report_cref->(
1878 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
1883 elsif ($$val ne $$reference_val) {
1884 $bad_slice_report_cref->(
1885 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
1891 elsif (! $value_type_idx->{$col_idx} ) { # regular non-literal value
1892 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
1893 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
1896 else { # binds from a \[], compare type and attrs
1897 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
1898 $bad_slice_report_cref->(
1899 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
1904 # start drilling down and bail out early on identical refs
1906 $reference_val != $val
1908 $$reference_val != $$val
1910 if (${$val}->[0] ne ${$reference_val}->[0]) {
1911 $bad_slice_report_cref->(
1912 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
1917 # need to check the bind attrs - a bind will happen only once for
1918 # the entire dataset, so any changes further down will be ignored.
1919 elsif (! Data::Compare::Compare(
1920 $value_type_idx->{$col_idx},
1924 @{$self->_resolve_bindattrs(
1925 $source, [ @{$$val}[1 .. $#$$val] ], $colinfo_cache,
1929 $bad_slice_report_cref->(
1930 'Differing bind attributes on literal/bind values not supported',
1940 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
1941 # are atomic (even if execute_for_fetch is a single call). Thus a safety
1943 my $guard = $self->txn_scope_guard;
1945 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
1946 my $sth = $self->_sth($sql);
1949 # proto bind contains the information on which pieces of $data to pull
1950 # $cols is passed in only for prettier error-reporting
1951 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
1954 # bind_param_array doesn't work if there are no binds
1955 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1959 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
1963 return (wantarray ? ($rv, $sth, @$proto_bind) : $rv);
1966 # execute_for_fetch is capable of returning data just fine (it means it
1967 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
1968 # is the void-populate fast-path we will just ignore this altogether
1969 # for the time being.
1970 sub _dbh_execute_for_fetch {
1971 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
1973 my @idx_range = ( 0 .. $#$proto_bind );
1975 # If we have any bind attributes to take care of, we will bind the
1976 # proto-bind data (which will never be used by execute_for_fetch)
1977 # However since column bindtypes are "sticky", this is sufficient
1978 # to get the DBD to apply the bindtype to all values later on
1980 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
1982 for my $i (@idx_range) {
1984 $i+1, # DBI bind indexes are 1-based
1985 $proto_bind->[$i][1],
1987 ) if defined $bind_attrs->[$i];
1990 # At this point $data slots named in the _bind_data_slice_idx of
1991 # each piece of $proto_bind are either \[]s or plain values to be
1992 # passed in. Construct the dispensing coderef. *NOTE* the order
1993 # of $data will differ from this of the ?s in the SQL (due to
1994 # alphabetical ordering by colname). We actually do want to
1995 # preserve this behavior so that prepare_cached has a better
1996 # chance of matching on unrelated calls
1997 my %data_reorder = map { $proto_bind->[$_][0]{_bind_data_slice_idx} => $_ } @idx_range;
1999 my $fetch_row_idx = -1; # saner loop this way
2000 my $fetch_tuple = sub {
2001 return undef if ++$fetch_row_idx > $#$data;
2004 { (ref $_ eq 'REF' and ref $$_ eq 'ARRAY')
2005 ? map { $_->[-1] } @{$$_}[1 .. $#$$_]
2009 { $data->[$fetch_row_idx][$_]}
2011 { $data_reorder{$a} <=> $data_reorder{$b} }
2016 my $tuple_status = [];
2019 $rv = $sth->execute_for_fetch(
2028 # Not all DBDs are create equal. Some throw on error, some return
2029 # an undef $rv, and some set $sth->err - try whatever we can
2030 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2033 ( !defined $rv or $sth->err )
2036 # Statement must finish even if there was an exception.
2041 $err = shift unless defined $err
2046 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2048 $self->throw_exception("Unexpected populate error: $err")
2049 if ($i > $#$tuple_status);
2051 require Data::Dumper::Concise;
2052 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2053 ($tuple_status->[$i][1] || $err),
2054 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2061 sub _dbh_execute_inserts_with_no_binds {
2062 my ($self, $sth, $count) = @_;
2066 my $dbh = $self->_get_dbh;
2067 local $dbh->{RaiseError} = 1;
2068 local $dbh->{PrintError} = 0;
2070 $sth->execute foreach 1..$count;
2076 # Make sure statement is finished even if there was an exception.
2081 $err = shift unless defined $err;
2084 $self->throw_exception($err) if defined $err;
2090 #my ($self, $source, @args) = @_;
2091 shift->_execute('update', @_);
2096 #my ($self, $source, @args) = @_;
2097 shift->_execute('delete', @_);
2102 $self->_execute($self->_select_args(@_));
2105 sub _select_args_to_query {
2108 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2109 # = $self->_select_args($ident, $select, $cond, $attrs);
2110 my ($op, $ident, @args) =
2111 $self->_select_args(@_);
2113 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2114 my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, \@args);
2115 $prepared_bind ||= [];
2118 ? ($sql, $prepared_bind)
2119 : \[ "($sql)", @$prepared_bind ]
2124 my ($self, $ident, $select, $where, $attrs) = @_;
2126 my $sql_maker = $self->sql_maker;
2127 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
2134 $rs_alias && $alias2source->{$rs_alias}
2135 ? ( _rsroot_rsrc => $alias2source->{$rs_alias} )
2140 # Sanity check the attributes (SQLMaker does it too, but
2141 # in case of a software_limit we'll never reach there)
2142 if (defined $attrs->{offset}) {
2143 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2144 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2147 if (defined $attrs->{rows}) {
2148 $self->throw_exception("The rows attribute must be a positive integer if present")
2149 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2151 elsif ($attrs->{offset}) {
2152 # MySQL actually recommends this approach. I cringe.
2153 $attrs->{rows} = $sql_maker->__max_int;
2158 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
2159 # storage, unless software limit was requested
2162 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
2164 # grouped prefetch (to satisfy group_by == select)
2165 ( $attrs->{group_by}
2167 @{$attrs->{group_by}}
2169 $attrs->{_prefetch_selector_range}
2172 ($ident, $select, $where, $attrs)
2173 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2175 elsif (! $attrs->{software_limit} ) {
2177 $attrs->{rows} || (),
2178 $attrs->{offset} || (),
2182 # try to simplify the joinmap further (prune unreferenced type-single joins)
2183 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2186 # This would be the point to deflate anything found in $where
2187 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2188 # expect a row object. And all we have is a resultsource (it is trivial
2189 # to extract deflator coderefs via $alias2source above).
2191 # I don't see a way forward other than changing the way deflators are
2192 # invoked, and that's just bad...
2195 return ('select', $ident, $select, $where, $attrs, @limit);
2198 # Returns a counting SELECT for a simple count
2199 # query. Abstracted so that a storage could override
2200 # this to { count => 'firstcol' } or whatever makes
2201 # sense as a performance optimization
2203 #my ($self, $source, $rs_attrs) = @_;
2204 return { count => '*' };
2207 sub source_bind_attributes {
2208 shift->throw_exception(
2209 'source_bind_attributes() was never meant to be a callable public method - '
2210 .'please contact the DBIC dev-team and describe your use case so that a reasonable '
2211 .'solution can be provided'
2212 ."\nhttp://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT"
2220 =item Arguments: $ident, $select, $condition, $attrs
2224 Handle a SQL select statement.
2230 my ($ident, $select, $condition, $attrs) = @_;
2231 return $self->cursor_class->new($self, \@_, $attrs);
2236 my ($rv, $sth, @bind) = $self->_select(@_);
2237 my @row = $sth->fetchrow_array;
2238 my @nextrow = $sth->fetchrow_array if @row;
2239 if(@row && @nextrow) {
2240 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2242 # Need to call finish() to work round broken DBDs
2247 =head2 sql_limit_dialect
2249 This is an accessor for the default SQL limit dialect used by a particular
2250 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2251 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2252 see L<DBIx::Class::SQLMaker::LimitDialects>.
2257 my ($self, $dbh, $sql) = @_;
2259 # 3 is the if_active parameter which avoids active sth re-use
2260 my $sth = $self->disable_sth_caching
2261 ? $dbh->prepare($sql)
2262 : $dbh->prepare_cached($sql, {}, 3);
2264 # XXX You would think RaiseError would make this impossible,
2265 # but apparently that's not true :(
2266 $self->throw_exception(
2269 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
2270 .'an exception and/or setting $dbh->errstr',
2272 ? substr($sql, 0, 20) . '...'
2275 'DBD::' . $dbh->{Driver}{Name},
2283 carp_unique 'sth was mistakenly marked/documented as public, stop calling it (will be removed before DBIC v0.09)';
2288 my ($self, $sql) = @_;
2289 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2292 sub _dbh_columns_info_for {
2293 my ($self, $dbh, $table) = @_;
2295 if ($dbh->can('column_info')) {
2299 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2300 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2302 while ( my $info = $sth->fetchrow_hashref() ){
2304 $column_info{data_type} = $info->{TYPE_NAME};
2305 $column_info{size} = $info->{COLUMN_SIZE};
2306 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2307 $column_info{default_value} = $info->{COLUMN_DEF};
2308 my $col_name = $info->{COLUMN_NAME};
2309 $col_name =~ s/^\"(.*)\"$/$1/;
2311 $result{$col_name} = \%column_info;
2316 return \%result if !$caught && scalar keys %result;
2320 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2322 my @columns = @{$sth->{NAME_lc}};
2323 for my $i ( 0 .. $#columns ){
2325 $column_info{data_type} = $sth->{TYPE}->[$i];
2326 $column_info{size} = $sth->{PRECISION}->[$i];
2327 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2329 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2330 $column_info{data_type} = $1;
2331 $column_info{size} = $2;
2334 $result{$columns[$i]} = \%column_info;
2338 foreach my $col (keys %result) {
2339 my $colinfo = $result{$col};
2340 my $type_num = $colinfo->{data_type};
2342 if(defined $type_num && $dbh->can('type_info')) {
2343 my $type_info = $dbh->type_info($type_num);
2344 $type_name = $type_info->{TYPE_NAME} if $type_info;
2345 $colinfo->{data_type} = $type_name if $type_name;
2352 sub columns_info_for {
2353 my ($self, $table) = @_;
2354 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2357 =head2 last_insert_id
2359 Return the row id of the last insert.
2363 sub _dbh_last_insert_id {
2364 my ($self, $dbh, $source, $col) = @_;
2366 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2368 return $id if defined $id;
2370 my $class = ref $self;
2371 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2374 sub last_insert_id {
2376 $self->_dbh_last_insert_id ($self->_dbh, @_);
2379 =head2 _native_data_type
2383 =item Arguments: $type_name
2387 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2388 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2389 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2391 The default implementation returns C<undef>, implement in your Storage driver if
2392 you need this functionality.
2394 Should map types from other databases to the native RDBMS type, for example
2395 C<VARCHAR2> to C<VARCHAR>.
2397 Types with modifiers should map to the underlying data type. For example,
2398 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2400 Composite types should map to the container type, for example
2401 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2405 sub _native_data_type {
2406 #my ($self, $data_type) = @_;
2410 # Check if placeholders are supported at all
2411 sub _determine_supports_placeholders {
2413 my $dbh = $self->_get_dbh;
2415 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2416 # but it is inaccurate more often than not
2418 local $dbh->{PrintError} = 0;
2419 local $dbh->{RaiseError} = 1;
2420 $dbh->do('select ?', {}, 1);
2428 # Check if placeholders bound to non-string types throw exceptions
2430 sub _determine_supports_typeless_placeholders {
2432 my $dbh = $self->_get_dbh;
2435 local $dbh->{PrintError} = 0;
2436 local $dbh->{RaiseError} = 1;
2437 # this specifically tests a bind that is NOT a string
2438 $dbh->do('select 1 where 1 = ?', {}, 1);
2448 Returns the database driver name.
2453 shift->_get_dbh->{Driver}->{Name};
2456 =head2 bind_attribute_by_data_type
2458 Given a datatype from column info, returns a database specific bind
2459 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2460 let the database planner just handle it.
2462 Generally only needed for special case column types, like bytea in postgres.
2466 sub bind_attribute_by_data_type {
2470 =head2 is_datatype_numeric
2472 Given a datatype from column_info, returns a boolean value indicating if
2473 the current RDBMS considers it a numeric value. This controls how
2474 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2475 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2476 be performed instead of the usual C<eq>.
2480 sub is_datatype_numeric {
2481 #my ($self, $dt) = @_;
2483 return 0 unless $_[1];
2486 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2491 =head2 create_ddl_dir
2495 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2499 Creates a SQL file based on the Schema, for each of the specified
2500 database engines in C<\@databases> in the given directory.
2501 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2503 Given a previous version number, this will also create a file containing
2504 the ALTER TABLE statements to transform the previous schema into the
2505 current one. Note that these statements may contain C<DROP TABLE> or
2506 C<DROP COLUMN> statements that can potentially destroy data.
2508 The file names are created using the C<ddl_filename> method below, please
2509 override this method in your schema if you would like a different file
2510 name format. For the ALTER file, the same format is used, replacing
2511 $version in the name with "$preversion-$version".
2513 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2514 The most common value for this would be C<< { add_drop_table => 1 } >>
2515 to have the SQL produced include a C<DROP TABLE> statement for each table
2516 created. For quoting purposes supply C<quote_table_names> and
2517 C<quote_field_names>.
2519 If no arguments are passed, then the following default values are assumed:
2523 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2525 =item version - $schema->schema_version
2527 =item directory - './'
2529 =item preversion - <none>
2533 By default, C<\%sqlt_args> will have
2535 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2537 merged with the hash passed in. To disable any of those features, pass in a
2538 hashref like the following
2540 { ignore_constraint_names => 0, # ... other options }
2543 WARNING: You are strongly advised to check all SQL files created, before applying
2548 sub create_ddl_dir {
2549 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2552 carp "No directory given, using ./\n";
2557 (require File::Path and File::Path::make_path ("$dir")) # make_path does not like objects (i.e. Path::Class::Dir)
2559 $self->throw_exception(
2560 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2564 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2566 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2567 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2569 my $schema_version = $schema->schema_version || '1.x';
2570 $version ||= $schema_version;
2573 add_drop_table => 1,
2574 ignore_constraint_names => 1,
2575 ignore_index_names => 1,
2579 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2580 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2583 my $sqlt = SQL::Translator->new( $sqltargs );
2585 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2586 my $sqlt_schema = $sqlt->translate({ data => $schema })
2587 or $self->throw_exception ($sqlt->error);
2589 foreach my $db (@$databases) {
2591 $sqlt->{schema} = $sqlt_schema;
2592 $sqlt->producer($db);
2595 my $filename = $schema->ddl_filename($db, $version, $dir);
2596 if (-e $filename && ($version eq $schema_version )) {
2597 # if we are dumping the current version, overwrite the DDL
2598 carp "Overwriting existing DDL file - $filename";
2602 my $output = $sqlt->translate;
2604 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2607 if(!open($file, ">$filename")) {
2608 $self->throw_exception("Can't open $filename for writing ($!)");
2611 print $file $output;
2614 next unless ($preversion);
2616 require SQL::Translator::Diff;
2618 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2619 if(!-e $prefilename) {
2620 carp("No previous schema file found ($prefilename)");
2624 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2626 carp("Overwriting existing diff file - $difffile");
2632 my $t = SQL::Translator->new($sqltargs);
2637 or $self->throw_exception ($t->error);
2639 my $out = $t->translate( $prefilename )
2640 or $self->throw_exception ($t->error);
2642 $source_schema = $t->schema;
2644 $source_schema->name( $prefilename )
2645 unless ( $source_schema->name );
2648 # The "new" style of producers have sane normalization and can support
2649 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2650 # And we have to diff parsed SQL against parsed SQL.
2651 my $dest_schema = $sqlt_schema;
2653 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2654 my $t = SQL::Translator->new($sqltargs);
2659 or $self->throw_exception ($t->error);
2661 my $out = $t->translate( $filename )
2662 or $self->throw_exception ($t->error);
2664 $dest_schema = $t->schema;
2666 $dest_schema->name( $filename )
2667 unless $dest_schema->name;
2670 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2674 if(!open $file, ">$difffile") {
2675 $self->throw_exception("Can't write to $difffile ($!)");
2683 =head2 deployment_statements
2687 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2691 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2693 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2694 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2696 C<$directory> is used to return statements from files in a previously created
2697 L</create_ddl_dir> directory and is optional. The filenames are constructed
2698 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2700 If no C<$directory> is specified then the statements are constructed on the
2701 fly using L<SQL::Translator> and C<$version> is ignored.
2703 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2707 sub deployment_statements {
2708 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2709 $type ||= $self->sqlt_type;
2710 $version ||= $schema->schema_version || '1.x';
2712 my $filename = $schema->ddl_filename($type, $version, $dir);
2715 # FIXME replace this block when a proper sane sql parser is available
2717 open($file, "<$filename")
2718 or $self->throw_exception("Can't open $filename ($!)");
2721 return join('', @rows);
2724 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2725 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2728 # sources needs to be a parser arg, but for simplicty allow at top level
2730 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2731 if exists $sqltargs->{sources};
2733 my $tr = SQL::Translator->new(
2734 producer => "SQL::Translator::Producer::${type}",
2736 parser => 'SQL::Translator::Parser::DBIx::Class',
2742 @ret = $tr->translate;
2745 $ret[0] = $tr->translate;
2748 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2749 unless (@ret && defined $ret[0]);
2751 return wantarray ? @ret : $ret[0];
2754 # FIXME deploy() currently does not accurately report sql errors
2755 # Will always return true while errors are warned
2757 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2761 return if($line =~ /^--/);
2762 # next if($line =~ /^DROP/m);
2763 return if($line =~ /^BEGIN TRANSACTION/m);
2764 return if($line =~ /^COMMIT/m);
2765 return if $line =~ /^\s+$/; # skip whitespace only
2766 $self->_query_start($line);
2768 # do a dbh_do cycle here, as we need some error checking in
2769 # place (even though we will ignore errors)
2770 $self->dbh_do (sub { $_[1]->do($line) });
2772 carp qq{$_ (running "${line}")};
2774 $self->_query_end($line);
2776 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2777 if (@statements > 1) {
2778 foreach my $statement (@statements) {
2779 $deploy->( $statement );
2782 elsif (@statements == 1) {
2783 # split on single line comments and end of statements
2784 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
2790 =head2 datetime_parser
2792 Returns the datetime parser class
2796 sub datetime_parser {
2798 return $self->{datetime_parser} ||= do {
2799 $self->build_datetime_parser(@_);
2803 =head2 datetime_parser_type
2805 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
2807 =head2 build_datetime_parser
2809 See L</datetime_parser>
2813 sub build_datetime_parser {
2815 my $type = $self->datetime_parser_type(@_);
2820 =head2 is_replicating
2822 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2823 replicate from a master database. Default is undef, which is the result
2824 returned by databases that don't support replication.
2828 sub is_replicating {
2833 =head2 lag_behind_master
2835 Returns a number that represents a certain amount of lag behind a master db
2836 when a given storage is replicating. The number is database dependent, but
2837 starts at zero and increases with the amount of lag. Default in undef
2841 sub lag_behind_master {
2845 =head2 relname_to_table_alias
2849 =item Arguments: $relname, $join_count
2853 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2856 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2857 way these aliases are named.
2859 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2860 otherwise C<"$relname">.
2864 sub relname_to_table_alias {
2865 my ($self, $relname, $join_count) = @_;
2867 my $alias = ($join_count && $join_count > 1 ?
2868 join('_', $relname, $join_count) : $relname);
2873 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
2874 # version and it may be necessary to amend or override it for a specific storage
2875 # if such binds are necessary.
2876 sub _max_column_bytesize {
2877 my ($self, $attr) = @_;
2881 if ($attr->{sqlt_datatype}) {
2882 my $data_type = lc($attr->{sqlt_datatype});
2884 if ($attr->{sqlt_size}) {
2886 # String/sized-binary types
2887 if ($data_type =~ /^(?:
2888 l? (?:var)? char(?:acter)? (?:\s*varying)?
2890 (?:var)? binary (?:\s*varying)?
2895 $max_size = $attr->{sqlt_size};
2897 # Other charset/unicode types, assume scale of 4
2898 elsif ($data_type =~ /^(?:
2899 national \s* character (?:\s*varying)?
2908 $max_size = $attr->{sqlt_size} * 4;
2912 if (!$max_size and !$self->_is_lob_type($data_type)) {
2913 $max_size = 100 # for all other (numeric?) datatypes
2917 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
2920 # Determine if a data_type is some type of BLOB
2922 my ($self, $data_type) = @_;
2923 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
2924 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
2925 |varchar|character\s*varying|nvarchar
2926 |national\s*character\s*varying))?\z/xi);
2929 sub _is_binary_lob_type {
2930 my ($self, $data_type) = @_;
2931 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
2932 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
2935 sub _is_text_lob_type {
2936 my ($self, $data_type) = @_;
2937 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
2938 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
2939 |national\s*character\s*varying))\z/xi);
2946 =head2 DBIx::Class and AutoCommit
2948 DBIx::Class can do some wonderful magic with handling exceptions,
2949 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2950 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
2951 transaction support.
2953 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2954 in an assumed transaction between commits, and you're telling us you'd
2955 like to manage that manually. A lot of the magic protections offered by
2956 this module will go away. We can't protect you from exceptions due to database
2957 disconnects because we don't know anything about how to restart your
2958 transactions. You're on your own for handling all sorts of exceptional
2959 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2965 Matt S. Trout <mst@shadowcatsystems.co.uk>
2967 Andy Grundman <andy@hybridized.org>
2971 You may distribute this code under the same terms as Perl itself.