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/;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use DBIx::Class::Storage::Statistics;
14 use Scalar::Util qw/refaddr weaken reftype blessed/;
15 use Data::Dumper::Concise 'Dumper';
16 use Sub::Name 'subname';
18 use File::Path 'make_path';
21 __PACKAGE__->mk_group_accessors('simple' => qw/
22 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
23 _dbh _server_info_hash _conn_pid _conn_tid _sql_maker _sql_maker_opts
24 transaction_depth _dbh_autocommit savepoints
27 # the values for these accessors are picked out (and deleted) from
28 # the attribute hashref passed to connect_info
29 my @storage_options = qw/
30 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
31 disable_sth_caching unsafe auto_savepoint
33 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
36 # default cursor class, overridable in connect_info attributes
37 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
39 __PACKAGE__->mk_group_accessors('inherited' => qw/
41 _supports_insert_returning
43 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
45 # Each of these methods need _determine_driver called before itself
46 # in order to function reliably. This is a purely DRY optimization
47 my @rdbms_specific_methods = qw/
62 for my $meth (@rdbms_specific_methods) {
64 my $orig = __PACKAGE__->can ($meth)
68 no warnings qw/redefine/;
69 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
70 if (not $_[0]->_driver_determined) {
71 $_[0]->_determine_driver;
72 goto $_[0]->can($meth);
81 DBIx::Class::Storage::DBI - DBI storage handler
85 my $schema = MySchema->connect('dbi:SQLite:my.db');
87 $schema->storage->debug(1);
89 my @stuff = $schema->storage->dbh_do(
91 my ($storage, $dbh, @args) = @_;
92 $dbh->do("DROP TABLE authors");
97 $schema->resultset('Book')->search({
98 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
103 This class represents the connection to an RDBMS via L<DBI>. See
104 L<DBIx::Class::Storage> for general information. This pod only
105 documents DBI-specific methods and behaviors.
112 my $new = shift->next::method(@_);
114 $new->transaction_depth(0);
115 $new->_sql_maker_opts({});
116 $new->{savepoints} = [];
117 $new->{_in_dbh_do} = 0;
118 $new->{_dbh_gen} = 0;
120 # read below to see what this does
121 $new->_arm_global_destructor;
126 # This is hack to work around perl shooting stuff in random
127 # order on exit(). If we do not walk the remaining storage
128 # objects in an END block, there is a *small but real* chance
129 # of a fork()ed child to kill the parent's shared DBI handle,
130 # *before perl reaches the DESTROY in this package*
131 # Yes, it is ugly and effective.
133 my %seek_and_destroy;
135 sub _arm_global_destructor {
137 my $key = Scalar::Util::refaddr ($self);
138 $seek_and_destroy{$key} = $self;
139 Scalar::Util::weaken ($seek_and_destroy{$key});
143 local $?; # just in case the DBI destructor changes it somehow
145 # destroy just the object if not native to this process/thread
146 $_->_preserve_foreign_dbh for (grep
148 values %seek_and_destroy
156 # destroy just the object if not native to this process/thread
157 $self->_preserve_foreign_dbh;
159 # some databases need this to stop spewing warnings
160 if (my $dbh = $self->_dbh) {
162 %{ $dbh->{CachedKids} } = ();
170 sub _preserve_foreign_dbh {
173 return unless $self->_dbh;
177 return unless $self->_dbh;
183 # handle pid changes correctly - do not destroy parent's connection
187 return if ( defined $self->_conn_pid and $self->_conn_pid == $$ );
189 $self->_dbh->{InactiveDestroy} = 1;
196 # very similar to above, but seems to FAIL if I set InactiveDestroy
200 if ( ! defined $self->_conn_tid ) {
203 elsif ( $self->_conn_tid == threads->tid ) {
204 return; # same thread
207 #$self->_dbh->{InactiveDestroy} = 1; # why does t/51threads.t fail...?
217 This method is normally called by L<DBIx::Class::Schema/connection>, which
218 encapsulates its argument list in an arrayref before passing them here.
220 The argument list may contain:
226 The same 4-element argument set one would normally pass to
227 L<DBI/connect>, optionally followed by
228 L<extra attributes|/DBIx::Class specific connection attributes>
229 recognized by DBIx::Class:
231 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
235 A single code reference which returns a connected
236 L<DBI database handle|DBI/connect> optionally followed by
237 L<extra attributes|/DBIx::Class specific connection attributes> recognized
240 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
244 A single hashref with all the attributes and the dsn/user/password
247 $connect_info_args = [{
255 $connect_info_args = [{
256 dbh_maker => sub { DBI->connect (...) },
261 This is particularly useful for L<Catalyst> based applications, allowing the
262 following config (L<Config::General> style):
267 dsn dbi:mysql:database=test
274 The C<dsn>/C<user>/C<password> combination can be substituted by the
275 C<dbh_maker> key whose value is a coderef that returns a connected
276 L<DBI database handle|DBI/connect>
280 Please note that the L<DBI> docs recommend that you always explicitly
281 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
282 recommends that it be set to I<1>, and that you perform transactions
283 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
284 to I<1> if you do not do explicitly set it to zero. This is the default
285 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
287 =head3 DBIx::Class specific connection attributes
289 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
290 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
291 the following connection options. These options can be mixed in with your other
292 L<DBI> connection attributes, or placed in a separate hashref
293 (C<\%extra_attributes>) as shown above.
295 Every time C<connect_info> is invoked, any previous settings for
296 these options will be cleared before setting the new ones, regardless of
297 whether any options are specified in the new C<connect_info>.
304 Specifies things to do immediately after connecting or re-connecting to
305 the database. Its value may contain:
311 This contains one SQL statement to execute.
313 =item an array reference
315 This contains SQL statements to execute in order. Each element contains
316 a string or a code reference that returns a string.
318 =item a code reference
320 This contains some code to execute. Unlike code references within an
321 array reference, its return value is ignored.
325 =item on_disconnect_do
327 Takes arguments in the same form as L</on_connect_do> and executes them
328 immediately before disconnecting from the database.
330 Note, this only runs if you explicitly call L</disconnect> on the
333 =item on_connect_call
335 A more generalized form of L</on_connect_do> that calls the specified
336 C<connect_call_METHOD> methods in your storage driver.
338 on_connect_do => 'select 1'
342 on_connect_call => [ [ do_sql => 'select 1' ] ]
344 Its values may contain:
350 Will call the C<connect_call_METHOD> method.
352 =item a code reference
354 Will execute C<< $code->($storage) >>
356 =item an array reference
358 Each value can be a method name or code reference.
360 =item an array of arrays
362 For each array, the first item is taken to be the C<connect_call_> method name
363 or code reference, and the rest are parameters to it.
367 Some predefined storage methods you may use:
373 Executes a SQL string or a code reference that returns a SQL string. This is
374 what L</on_connect_do> and L</on_disconnect_do> use.
382 Will execute the scalar as SQL.
386 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
387 attributes hashref and bind values.
389 =item a code reference
391 Will execute C<< $code->($storage) >> and execute the return array refs as
398 Execute any statements necessary to initialize the database session to return
399 and accept datetime/timestamp values used with
400 L<DBIx::Class::InflateColumn::DateTime>.
402 Only necessary for some databases, see your specific storage driver for
403 implementation details.
407 =item on_disconnect_call
409 Takes arguments in the same form as L</on_connect_call> and executes them
410 immediately before disconnecting from the database.
412 Calls the C<disconnect_call_METHOD> methods as opposed to the
413 C<connect_call_METHOD> methods called by L</on_connect_call>.
415 Note, this only runs if you explicitly call L</disconnect> on the
418 =item disable_sth_caching
420 If set to a true value, this option will disable the caching of
421 statement handles via L<DBI/prepare_cached>.
425 Sets the limit dialect. This is useful for JDBC-bridge among others
426 where the remote SQL-dialect cannot be determined by the name of the
427 driver alone. See also L<SQL::Abstract::Limit>.
431 Specifies what characters to use to quote table and column names. If
432 you use this you will want to specify L</name_sep> as well.
434 C<quote_char> expects either a single character, in which case is it
435 is placed on either side of the table/column name, or an arrayref of length
436 2 in which case the table/column name is placed between the elements.
438 For example under MySQL you should use C<< quote_char => '`' >>, and for
439 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
443 This only needs to be used in conjunction with C<quote_char>, and is used to
444 specify the character that separates elements (schemas, tables, columns) from
445 each other. In most cases this is simply a C<.>.
447 The consequences of not supplying this value is that L<SQL::Abstract>
448 will assume DBIx::Class' uses of aliases to be complete column
449 names. The output will look like I<"me.name"> when it should actually
454 This Storage driver normally installs its own C<HandleError>, sets
455 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
456 all database handles, including those supplied by a coderef. It does this
457 so that it can have consistent and useful error behavior.
459 If you set this option to a true value, Storage will not do its usual
460 modifications to the database handle's attributes, and instead relies on
461 the settings in your connect_info DBI options (or the values you set in
462 your connection coderef, in the case that you are connecting via coderef).
464 Note that your custom settings can cause Storage to malfunction,
465 especially if you set a C<HandleError> handler that suppresses exceptions
466 and/or disable C<RaiseError>.
470 If this option is true, L<DBIx::Class> will use savepoints when nesting
471 transactions, making it possible to recover from failure in the inner
472 transaction without having to abort all outer transactions.
476 Use this argument to supply a cursor class other than the default
477 L<DBIx::Class::Storage::DBI::Cursor>.
481 Some real-life examples of arguments to L</connect_info> and
482 L<DBIx::Class::Schema/connect>
484 # Simple SQLite connection
485 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
488 ->connect_info([ sub { DBI->connect(...) } ]);
490 # Connect via subref in hashref
492 dbh_maker => sub { DBI->connect(...) },
493 on_connect_do => 'alter session ...',
496 # A bit more complicated
503 { quote_char => q{"}, name_sep => q{.} },
507 # Equivalent to the previous example
513 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
517 # Same, but with hashref as argument
518 # See parse_connect_info for explanation
521 dsn => 'dbi:Pg:dbname=foo',
523 password => 'my_pg_password',
530 # Subref + DBIx::Class-specific connection options
533 sub { DBI->connect(...) },
537 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
538 disable_sth_caching => 1,
548 my ($self, $info) = @_;
550 return $self->_connect_info if !$info;
552 $self->_connect_info($info); # copy for _connect_info
554 $info = $self->_normalize_connect_info($info)
555 if ref $info eq 'ARRAY';
557 for my $storage_opt (keys %{ $info->{storage_options} }) {
558 my $value = $info->{storage_options}{$storage_opt};
560 $self->$storage_opt($value);
563 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
564 # the new set of options
565 $self->_sql_maker(undef);
566 $self->_sql_maker_opts({});
568 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
569 my $value = $info->{sql_maker_options}{$sql_maker_opt};
571 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
575 %{ $self->_default_dbi_connect_attributes || {} },
576 %{ $info->{attributes} || {} },
579 my @args = @{ $info->{arguments} };
581 $self->_dbi_connect_info([@args,
582 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
585 # save attributes them in a separate accessor so they are always
586 # introspectable, even in case of a CODE $dbhmaker
587 $self->_dbic_connect_attributes (\%attrs);
589 return $self->_connect_info;
592 sub _normalize_connect_info {
593 my ($self, $info_arg) = @_;
596 my @args = @$info_arg; # take a shallow copy for further mutilation
598 # combine/pre-parse arguments depending on invocation style
601 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
602 %attrs = %{ $args[1] || {} };
605 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
606 %attrs = %{$args[0]};
608 if (my $code = delete $attrs{dbh_maker}) {
611 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
614 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
615 . "to the result of 'dbh_maker'",
617 join (', ', map { "'$_'" } (@ignored) ),
622 @args = delete @attrs{qw/dsn user password/};
625 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
627 % { $args[3] || {} },
628 % { $args[4] || {} },
630 @args = @args[0,1,2];
633 $info{arguments} = \@args;
635 my @storage_opts = grep exists $attrs{$_},
636 @storage_options, 'cursor_class';
638 @{ $info{storage_options} }{@storage_opts} =
639 delete @attrs{@storage_opts} if @storage_opts;
641 my @sql_maker_opts = grep exists $attrs{$_},
642 qw/limit_dialect quote_char name_sep/;
644 @{ $info{sql_maker_options} }{@sql_maker_opts} =
645 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
647 $info{attributes} = \%attrs if %attrs;
652 sub _default_dbi_connect_attributes {
662 This method is deprecated in favour of setting via L</connect_info>.
666 =head2 on_disconnect_do
668 This method is deprecated in favour of setting via L</connect_info>.
672 sub _parse_connect_do {
673 my ($self, $type) = @_;
675 my $val = $self->$type;
676 return () if not defined $val;
681 push @res, [ 'do_sql', $val ];
682 } elsif (ref($val) eq 'CODE') {
684 } elsif (ref($val) eq 'ARRAY') {
685 push @res, map { [ 'do_sql', $_ ] } @$val;
687 $self->throw_exception("Invalid type for $type: ".ref($val));
695 Arguments: ($subref | $method_name), @extra_coderef_args?
697 Execute the given $subref or $method_name using the new exception-based
698 connection management.
700 The first two arguments will be the storage object that C<dbh_do> was called
701 on and a database handle to use. Any additional arguments will be passed
702 verbatim to the called subref as arguments 2 and onwards.
704 Using this (instead of $self->_dbh or $self->dbh) ensures correct
705 exception handling and reconnection (or failover in future subclasses).
707 Your subref should have no side-effects outside of the database, as
708 there is the potential for your subref to be partially double-executed
709 if the database connection was stale/dysfunctional.
713 my @stuff = $schema->storage->dbh_do(
715 my ($storage, $dbh, @cols) = @_;
716 my $cols = join(q{, }, @cols);
717 $dbh->selectrow_array("SELECT $cols FROM foo");
728 my $dbh = $self->_get_dbh;
730 return $self->$code($dbh, @_)
731 if ( $self->{_in_dbh_do} || $self->{transaction_depth} );
733 local $self->{_in_dbh_do} = 1;
735 # take a ref instead of a copy, to preserve coderef @_ aliasing semantics
738 $self->$code ($dbh, @$args);
740 $self->throw_exception($_) if $self->connected;
742 # We were not connected - reconnect and retry, but let any
743 # exception fall right through this time
744 carp "Retrying $code after catching disconnected exception: $_"
745 if $ENV{DBIC_DBIRETRY_DEBUG};
747 $self->_populate_dbh;
748 $self->$code($self->_dbh, @$args);
752 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
753 # It also informs dbh_do to bypass itself while under the direction of txn_do,
754 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
759 ref $coderef eq 'CODE' or $self->throw_exception
760 ('$coderef must be a CODE reference');
762 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
764 local $self->{_in_dbh_do} = 1;
767 my $want_array = wantarray;
773 # take a ref instead of a copy, to preserve coderef @_ aliasing semantics
781 @result = $coderef->(@$args);
783 elsif(defined $want_array) {
784 $result[0] = $coderef->(@$args);
794 if(! defined $exception) { return $want_array ? @result : $result[0] }
796 if($tried++ || $self->connected) {
797 my $rollback_exception;
798 try { $self->txn_rollback } catch { $rollback_exception = shift };
799 if(defined $rollback_exception) {
800 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
801 $self->throw_exception($exception) # propagate nested rollback
802 if $rollback_exception =~ /$exception_class/;
804 $self->throw_exception(
805 "Transaction aborted: ${exception}. "
806 . "Rollback failed: ${rollback_exception}"
809 $self->throw_exception($exception)
812 # We were not connected, and was first try - reconnect and retry
814 carp "Retrying $coderef after catching disconnected exception: $exception"
815 if $ENV{DBIC_DBIRETRY_DEBUG};
816 $self->_populate_dbh;
822 Our C<disconnect> method also performs a rollback first if the
823 database is not in C<AutoCommit> mode.
833 push @actions, ( $self->on_disconnect_call || () );
834 push @actions, $self->_parse_connect_do ('on_disconnect_do');
836 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
838 $self->_dbh_rollback unless $self->_dbh_autocommit;
840 %{ $self->_dbh->{CachedKids} } = ();
841 $self->_dbh->disconnect;
847 =head2 with_deferred_fk_checks
851 =item Arguments: C<$coderef>
853 =item Return Value: The return value of $coderef
857 Storage specific method to run the code ref with FK checks deferred or
858 in MySQL's case disabled entirely.
862 # Storage subclasses should override this
863 sub with_deferred_fk_checks {
864 my ($self, $sub) = @_;
872 =item Arguments: none
874 =item Return Value: 1|0
878 Verifies that the current database handle is active and ready to execute
879 an SQL statement (e.g. the connection did not get stale, server is still
880 answering, etc.) This method is used internally by L</dbh>.
886 return 0 unless $self->_seems_connected;
889 local $self->_dbh->{RaiseError} = 1;
894 sub _seems_connected {
897 $self->_preserve_foreign_dbh;
899 my $dbh = $self->_dbh
902 return $dbh->FETCH('Active');
908 my $dbh = $self->_dbh or return 0;
913 sub ensure_connected {
916 unless ($self->connected) {
917 $self->_populate_dbh;
923 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
924 is guaranteed to be healthy by implicitly calling L</connected>, and if
925 necessary performing a reconnection before returning. Keep in mind that this
926 is very B<expensive> on some database engines. Consider using L</dbh_do>
934 if (not $self->_dbh) {
935 $self->_populate_dbh;
937 $self->ensure_connected;
942 # this is the internal "get dbh or connect (don't check)" method
945 $self->_preserve_foreign_dbh;
946 $self->_populate_dbh unless $self->_dbh;
950 sub _sql_maker_args {
955 array_datatypes => 1,
956 limit_dialect => $self->_get_dbh,
957 %{$self->_sql_maker_opts}
963 unless ($self->_sql_maker) {
964 my $sql_maker_class = $self->sql_maker_class;
965 $self->ensure_class_loaded ($sql_maker_class);
966 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
968 return $self->_sql_maker;
971 # nothing to do by default
978 my @info = @{$self->_dbi_connect_info || []};
979 $self->_dbh(undef); # in case ->connected failed we might get sent here
980 $self->_server_info_hash (undef);
981 $self->_dbh($self->_connect(@info));
983 $self->_conn_pid($$);
984 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
986 $self->_determine_driver;
988 # Always set the transaction depth on connect, since
989 # there is no transaction in progress by definition
990 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
992 $self->_run_connection_actions unless $self->{_in_determine_driver};
995 sub _run_connection_actions {
999 push @actions, ( $self->on_connect_call || () );
1000 push @actions, $self->_parse_connect_do ('on_connect_do');
1002 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1008 unless ($self->_server_info_hash) {
1012 my $server_version = try { $self->_get_server_version };
1014 if (defined $server_version) {
1015 $info{dbms_version} = $server_version;
1017 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1018 my @verparts = split (/\./, $numeric_version);
1024 # consider only up to 3 version parts, iff not more than 3 digits
1026 while (@verparts && @use_parts < 3) {
1027 my $p = shift @verparts;
1029 push @use_parts, $p;
1031 push @use_parts, 0 while @use_parts < 3;
1033 $info{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1037 $self->_server_info_hash(\%info);
1040 return $self->_server_info_hash
1043 sub _get_server_version {
1044 shift->_get_dbh->get_info(18);
1047 sub _determine_driver {
1050 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1051 my $started_connected = 0;
1052 local $self->{_in_determine_driver} = 1;
1054 if (ref($self) eq __PACKAGE__) {
1056 if ($self->_dbh) { # we are connected
1057 $driver = $self->_dbh->{Driver}{Name};
1058 $started_connected = 1;
1060 # if connect_info is a CODEREF, we have no choice but to connect
1061 if (ref $self->_dbi_connect_info->[0] &&
1062 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1063 $self->_populate_dbh;
1064 $driver = $self->_dbh->{Driver}{Name};
1067 # try to use dsn to not require being connected, the driver may still
1068 # force a connection in _rebless to determine version
1069 # (dsn may not be supplied at all if all we do is make a mock-schema)
1070 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1071 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1072 $driver ||= $ENV{DBI_DRIVER};
1077 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1078 if ($self->load_optional_class($storage_class)) {
1079 mro::set_mro($storage_class, 'c3');
1080 bless $self, $storage_class;
1086 $self->_driver_determined(1);
1088 $self->_init; # run driver-specific initializations
1090 $self->_run_connection_actions
1091 if !$started_connected && defined $self->_dbh;
1095 sub _do_connection_actions {
1097 my $method_prefix = shift;
1100 if (not ref($call)) {
1101 my $method = $method_prefix . $call;
1103 } elsif (ref($call) eq 'CODE') {
1105 } elsif (ref($call) eq 'ARRAY') {
1106 if (ref($call->[0]) ne 'ARRAY') {
1107 $self->_do_connection_actions($method_prefix, $_) for @$call;
1109 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1112 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1118 sub connect_call_do_sql {
1120 $self->_do_query(@_);
1123 sub disconnect_call_do_sql {
1125 $self->_do_query(@_);
1128 # override in db-specific backend when necessary
1129 sub connect_call_datetime_setup { 1 }
1132 my ($self, $action) = @_;
1134 if (ref $action eq 'CODE') {
1135 $action = $action->($self);
1136 $self->_do_query($_) foreach @$action;
1139 # Most debuggers expect ($sql, @bind), so we need to exclude
1140 # the attribute hash which is the second argument to $dbh->do
1141 # furthermore the bind values are usually to be presented
1142 # as named arrayref pairs, so wrap those here too
1143 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1144 my $sql = shift @do_args;
1145 my $attrs = shift @do_args;
1146 my @bind = map { [ undef, $_ ] } @do_args;
1148 $self->_query_start($sql, @bind);
1149 $self->_get_dbh->do($sql, $attrs, @do_args);
1150 $self->_query_end($sql, @bind);
1157 my ($self, @info) = @_;
1159 $self->throw_exception("You failed to provide any connection info")
1162 my ($old_connect_via, $dbh);
1164 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1165 $old_connect_via = $DBI::connect_via;
1166 $DBI::connect_via = 'connect';
1169 # FIXME - this should have been Try::Tiny, but triggers a leak-bug in perl(!)
1170 # related to coderef refcounting. A failing test has been submitted to T::T
1171 my $connect_ok = eval {
1172 if(ref $info[0] eq 'CODE') {
1173 $dbh = $info[0]->();
1176 $dbh = DBI->connect(@info);
1183 unless ($self->unsafe) {
1184 my $weak_self = $self;
1186 $dbh->{HandleError} = sub {
1188 $weak_self->throw_exception("DBI Exception: $_[0]");
1191 # the handler may be invoked by something totally out of
1193 croak ("DBI Exception: $_[0]");
1196 $dbh->{ShowErrorStatement} = 1;
1197 $dbh->{RaiseError} = 1;
1198 $dbh->{PrintError} = 0;
1204 my $possible_err = $@;
1205 $DBI::connect_via = $old_connect_via if $old_connect_via;
1207 unless ($connect_ok) {
1208 $self->throw_exception("DBI Connection failed: $possible_err")
1211 $self->_dbh_autocommit($dbh->{AutoCommit});
1216 my ($self, $name) = @_;
1218 $name = $self->_svp_generate_name
1219 unless defined $name;
1221 $self->throw_exception ("You can't use savepoints outside a transaction")
1222 if $self->{transaction_depth} == 0;
1224 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1225 unless $self->can('_svp_begin');
1227 push @{ $self->{savepoints} }, $name;
1229 $self->debugobj->svp_begin($name) if $self->debug;
1231 return $self->_svp_begin($name);
1235 my ($self, $name) = @_;
1237 $self->throw_exception ("You can't use savepoints outside a transaction")
1238 if $self->{transaction_depth} == 0;
1240 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1241 unless $self->can('_svp_release');
1243 if (defined $name) {
1244 $self->throw_exception ("Savepoint '$name' does not exist")
1245 unless grep { $_ eq $name } @{ $self->{savepoints} };
1247 # Dig through the stack until we find the one we are releasing. This keeps
1248 # the stack up to date.
1251 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1253 $name = pop @{ $self->{savepoints} };
1256 $self->debugobj->svp_release($name) if $self->debug;
1258 return $self->_svp_release($name);
1262 my ($self, $name) = @_;
1264 $self->throw_exception ("You can't use savepoints outside a transaction")
1265 if $self->{transaction_depth} == 0;
1267 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1268 unless $self->can('_svp_rollback');
1270 if (defined $name) {
1271 # If they passed us a name, verify that it exists in the stack
1272 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1273 $self->throw_exception("Savepoint '$name' does not exist!");
1276 # Dig through the stack until we find the one we are releasing. This keeps
1277 # the stack up to date.
1278 while(my $s = pop(@{ $self->{savepoints} })) {
1279 last if($s eq $name);
1281 # Add the savepoint back to the stack, as a rollback doesn't remove the
1282 # named savepoint, only everything after it.
1283 push(@{ $self->{savepoints} }, $name);
1285 # We'll assume they want to rollback to the last savepoint
1286 $name = $self->{savepoints}->[-1];
1289 $self->debugobj->svp_rollback($name) if $self->debug;
1291 return $self->_svp_rollback($name);
1294 sub _svp_generate_name {
1297 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1303 # this means we have not yet connected and do not know the AC status
1304 # (e.g. coderef $dbh)
1305 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1307 if($self->{transaction_depth} == 0) {
1308 $self->debugobj->txn_begin()
1310 $self->_dbh_begin_work;
1312 elsif ($self->auto_savepoint) {
1315 $self->{transaction_depth}++;
1318 sub _dbh_begin_work {
1321 # if the user is utilizing txn_do - good for him, otherwise we need to
1322 # ensure that the $dbh is healthy on BEGIN.
1323 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1324 # will be replaced by a failure of begin_work itself (which will be
1325 # then retried on reconnect)
1326 if ($self->{_in_dbh_do}) {
1327 $self->_dbh->begin_work;
1329 $self->dbh_do(sub { $_[1]->begin_work });
1335 if ($self->{transaction_depth} == 1) {
1336 $self->debugobj->txn_commit()
1339 $self->{transaction_depth} = 0
1340 if $self->_dbh_autocommit;
1342 elsif($self->{transaction_depth} > 1) {
1343 $self->{transaction_depth}--;
1345 if $self->auto_savepoint;
1351 my $dbh = $self->_dbh
1352 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1358 my $dbh = $self->_dbh;
1360 if ($self->{transaction_depth} == 1) {
1361 $self->debugobj->txn_rollback()
1363 $self->{transaction_depth} = 0
1364 if $self->_dbh_autocommit;
1365 $self->_dbh_rollback;
1367 elsif($self->{transaction_depth} > 1) {
1368 $self->{transaction_depth}--;
1369 if ($self->auto_savepoint) {
1370 $self->svp_rollback;
1375 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1379 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1381 if ($_ !~ /$exception_class/) {
1382 # ensure that a failed rollback resets the transaction depth
1383 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1386 $self->throw_exception($_)
1392 my $dbh = $self->_dbh
1393 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1397 # This used to be the top-half of _execute. It was split out to make it
1398 # easier to override in NoBindVars without duping the rest. It takes up
1399 # all of _execute's args, and emits $sql, @bind.
1400 sub _prep_for_execute {
1401 my ($self, $op, $extra_bind, $ident, $args) = @_;
1403 if( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
1404 $ident = $ident->from();
1407 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1410 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1412 return ($sql, \@bind);
1416 sub _fix_bind_params {
1417 my ($self, @bind) = @_;
1419 ### Turn @bind from something like this:
1420 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1422 ### ( "'1'", "'1'", "'3'" )
1425 if ( defined( $_ && $_->[1] ) ) {
1426 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1433 my ( $self, $sql, @bind ) = @_;
1435 if ( $self->debug ) {
1436 @bind = $self->_fix_bind_params(@bind);
1438 $self->debugobj->query_start( $sql, @bind );
1443 my ( $self, $sql, @bind ) = @_;
1445 if ( $self->debug ) {
1446 @bind = $self->_fix_bind_params(@bind);
1447 $self->debugobj->query_end( $sql, @bind );
1452 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1454 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1456 $self->_query_start( $sql, @$bind );
1458 my $sth = $self->sth($sql,$op);
1460 my $placeholder_index = 1;
1462 foreach my $bound (@$bind) {
1463 my $attributes = {};
1464 my($column_name, @data) = @$bound;
1466 if ($bind_attributes) {
1467 $attributes = $bind_attributes->{$column_name}
1468 if defined $bind_attributes->{$column_name};
1471 foreach my $data (@data) {
1472 my $ref = ref $data;
1473 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1475 $sth->bind_param($placeholder_index, $data, $attributes);
1476 $placeholder_index++;
1480 # Can this fail without throwing an exception anyways???
1481 my $rv = $sth->execute();
1482 $self->throw_exception(
1483 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1486 $self->_query_end( $sql, @$bind );
1488 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1493 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1496 sub _prefetch_insert_auto_nextvals {
1497 my ($self, $source, $to_insert) = @_;
1501 foreach my $col ( $source->columns ) {
1502 if ( !defined $to_insert->{$col} ) {
1503 my $col_info = $source->column_info($col);
1505 if ( $col_info->{auto_nextval} ) {
1506 $upd->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1508 $col_info->{sequence} ||=
1509 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1520 my ($source, $to_insert, $opts) = @_;
1522 my $updated_cols = $self->_prefetch_insert_auto_nextvals (@_);
1524 my $bind_attributes = $self->source_bind_attributes($source);
1526 my ($rv, $sth) = $self->_execute('insert' => [], $source, $bind_attributes, $to_insert, $opts);
1528 if ($opts->{returning}) {
1529 my @ret_cols = @{$opts->{returning}};
1531 my @ret_vals = try {
1532 local $SIG{__WARN__} = sub {};
1533 my @r = $sth->fetchrow_array;
1539 @ret{@ret_cols} = @ret_vals if (@ret_vals);
1547 return $updated_cols;
1550 ## Currently it is assumed that all values passed will be "normal", i.e. not
1551 ## scalar refs, or at least, all the same type as the first set, the statement is
1552 ## only prepped once.
1554 my ($self, $source, $cols, $data) = @_;
1557 @colvalues{@$cols} = (0..$#$cols);
1559 for my $i (0..$#$cols) {
1560 my $first_val = $data->[0][$i];
1561 next unless ref $first_val eq 'SCALAR';
1563 $colvalues{ $cols->[$i] } = $first_val;
1566 # check for bad data and stringify stringifiable objects
1567 my $bad_slice = sub {
1568 my ($msg, $col_idx, $slice_idx) = @_;
1569 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1573 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1575 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1581 for my $datum_idx (0..$#$data) {
1582 my $datum = $data->[$datum_idx];
1584 for my $col_idx (0..$#$cols) {
1585 my $val = $datum->[$col_idx];
1586 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1587 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1589 if ($is_literal_sql) {
1591 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1593 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1594 $bad_slice->("$reftype reference found where literal SQL expected",
1595 $col_idx, $datum_idx);
1597 elsif ($$val ne $$sqla_bind){
1598 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1599 $col_idx, $datum_idx);
1602 elsif (my $reftype = ref $val) {
1604 if (overload::Method($val, '""')) {
1605 $datum->[$col_idx] = "".$val;
1608 $bad_slice->("$reftype reference found where bind expected",
1609 $col_idx, $datum_idx);
1615 my ($sql, $bind) = $self->_prep_for_execute (
1616 'insert', undef, $source, [\%colvalues]
1620 my $empty_bind = 1 if (not @bind) &&
1621 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1623 if ((not @bind) && (not $empty_bind)) {
1624 $self->throw_exception(
1625 'Cannot insert_bulk without support for placeholders'
1629 # neither _execute_array, nor _execute_inserts_with_no_binds are
1630 # atomic (even if _execute _array is a single call). Thus a safety
1632 my $guard = $self->txn_scope_guard;
1634 $self->_query_start( $sql, [ dummy => '__BULK_INSERT__' ] );
1635 my $sth = $self->sth($sql);
1638 # bind_param_array doesn't work if there are no binds
1639 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1642 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1643 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1647 $self->_query_end( $sql, [ dummy => '__BULK_INSERT__' ] );
1651 return (wantarray ? ($rv, $sth, @bind) : $rv);
1654 sub _execute_array {
1655 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1657 ## This must be an arrayref, else nothing works!
1658 my $tuple_status = [];
1660 ## Get the bind_attributes, if any exist
1661 my $bind_attributes = $self->source_bind_attributes($source);
1663 ## Bind the values and execute
1664 my $placeholder_index = 1;
1666 foreach my $bound (@$bind) {
1668 my $attributes = {};
1669 my ($column_name, $data_index) = @$bound;
1671 if( $bind_attributes ) {
1672 $attributes = $bind_attributes->{$column_name}
1673 if defined $bind_attributes->{$column_name};
1676 my @data = map { $_->[$data_index] } @$data;
1678 $sth->bind_param_array(
1681 (%$attributes ? $attributes : ()),
1683 $placeholder_index++;
1688 $rv = $self->_dbh_execute_array($sth, $tuple_status, @extra);
1694 # Statement must finish even if there was an exception.
1699 $err = shift unless defined $err
1704 if (! defined $err and $sth->err);
1708 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1710 $self->throw_exception("Unexpected populate error: $err")
1711 if ($i > $#$tuple_status);
1713 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1714 ($tuple_status->[$i][1] || $err),
1715 Dumper { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) },
1722 sub _dbh_execute_array {
1723 my ($self, $sth, $tuple_status, @extra) = @_;
1725 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1728 sub _dbh_execute_inserts_with_no_binds {
1729 my ($self, $sth, $count) = @_;
1733 my $dbh = $self->_get_dbh;
1734 local $dbh->{RaiseError} = 1;
1735 local $dbh->{PrintError} = 0;
1737 $sth->execute foreach 1..$count;
1743 # Make sure statement is finished even if there was an exception.
1748 $err = shift unless defined $err;
1752 $self->throw_exception($err) if defined $err;
1758 my ($self, $source, @args) = @_;
1760 my $bind_attrs = $self->source_bind_attributes($source);
1762 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1767 my ($self, $source, @args) = @_;
1769 my $bind_attrs = $self->source_bind_attributes($source);
1771 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1774 # We were sent here because the $rs contains a complex search
1775 # which will require a subquery to select the correct rows
1776 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1778 # Generating a single PK column subquery is trivial and supported
1779 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1780 # Look at _multipk_update_delete()
1781 sub _subq_update_delete {
1783 my ($rs, $op, $values) = @_;
1785 my $rsrc = $rs->result_source;
1787 # quick check if we got a sane rs on our hands
1788 my @pcols = $rsrc->_pri_cols;
1790 my $sel = $rs->_resolved_attrs->{select};
1791 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1794 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1796 join ("\x00", sort @$sel )
1798 $self->throw_exception (
1799 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1806 $op eq 'update' ? $values : (),
1807 { $pcols[0] => { -in => $rs->as_query } },
1812 return $self->_multipk_update_delete (@_);
1816 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1817 # resultset update/delete involving subqueries. So by default resort
1818 # to simple (and inefficient) delete_all style per-row opearations,
1819 # while allowing specific storages to override this with a faster
1822 sub _multipk_update_delete {
1823 return shift->_per_row_update_delete (@_);
1826 # This is the default loop used to delete/update rows for multi PK
1827 # resultsets, and used by mysql exclusively (because it can't do anything
1830 # We do not use $row->$op style queries, because resultset update/delete
1831 # is not expected to cascade (this is what delete_all/update_all is for).
1833 # There should be no race conditions as the entire operation is rolled
1836 sub _per_row_update_delete {
1838 my ($rs, $op, $values) = @_;
1840 my $rsrc = $rs->result_source;
1841 my @pcols = $rsrc->_pri_cols;
1843 my $guard = $self->txn_scope_guard;
1845 # emulate the return value of $sth->execute for non-selects
1846 my $row_cnt = '0E0';
1848 my $subrs_cur = $rs->cursor;
1849 my @all_pk = $subrs_cur->all;
1850 for my $pks ( @all_pk) {
1853 for my $i (0.. $#pcols) {
1854 $cond->{$pcols[$i]} = $pks->[$i];
1859 $op eq 'update' ? $values : (),
1873 $self->_execute($self->_select_args(@_));
1876 sub _select_args_to_query {
1879 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $rs_attrs, $rows, $offset)
1880 # = $self->_select_args($ident, $select, $cond, $attrs);
1881 my ($op, $bind, $ident, $bind_attrs, @args) =
1882 $self->_select_args(@_);
1884 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
1885 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1886 $prepared_bind ||= [];
1889 ? ($sql, $prepared_bind, $bind_attrs)
1890 : \[ "($sql)", @$prepared_bind ]
1895 my ($self, $ident, $select, $where, $attrs) = @_;
1897 my $sql_maker = $self->sql_maker;
1898 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1905 $rs_alias && $alias2source->{$rs_alias}
1906 ? ( _rsroot_source_handle => $alias2source->{$rs_alias}->handle )
1911 # calculate bind_attrs before possible $ident mangling
1912 my $bind_attrs = {};
1913 for my $alias (keys %$alias2source) {
1914 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1915 for my $col (keys %$bindtypes) {
1917 my $fqcn = join ('.', $alias, $col);
1918 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1920 # Unqialified column names are nice, but at the same time can be
1921 # rather ambiguous. What we do here is basically go along with
1922 # the loop, adding an unqualified column slot to $bind_attrs,
1923 # alongside the fully qualified name. As soon as we encounter
1924 # another column by that name (which would imply another table)
1925 # we unset the unqualified slot and never add any info to it
1926 # to avoid erroneous type binding. If this happens the users
1927 # only choice will be to fully qualify his column name
1929 if (exists $bind_attrs->{$col}) {
1930 $bind_attrs->{$col} = {};
1933 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1939 if (defined $attrs->{rows}) {
1940 $self->throw_exception("rows attribute must be positive if present")
1941 unless $attrs->{rows} > 0;
1943 elsif (defined $attrs->{offset}) {
1944 # MySQL actually recommends this approach. I cringe.
1945 $attrs->{rows} = $sql_maker->__max_int;
1950 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1951 # storage, unless software limit was requested
1954 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1956 # grouped prefetch (to satisfy group_by == select)
1957 ( $attrs->{group_by}
1959 @{$attrs->{group_by}}
1961 $attrs->{_prefetch_select}
1963 @{$attrs->{_prefetch_select}}
1966 ($ident, $select, $where, $attrs)
1967 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1969 elsif (! $attrs->{software_limit} ) {
1970 push @limit, $attrs->{rows}, $attrs->{offset};
1973 # try to simplify the joinmap further (prune unreferenced type-single joins)
1974 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1977 # This would be the point to deflate anything found in $where
1978 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1979 # expect a row object. And all we have is a resultsource (it is trivial
1980 # to extract deflator coderefs via $alias2source above).
1982 # I don't see a way forward other than changing the way deflators are
1983 # invoked, and that's just bad...
1986 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $attrs, @limit);
1989 # Returns a counting SELECT for a simple count
1990 # query. Abstracted so that a storage could override
1991 # this to { count => 'firstcol' } or whatever makes
1992 # sense as a performance optimization
1994 #my ($self, $source, $rs_attrs) = @_;
1995 return { count => '*' };
1999 sub source_bind_attributes {
2000 my ($self, $source) = @_;
2002 my $bind_attributes;
2003 foreach my $column ($source->columns) {
2005 my $data_type = $source->column_info($column)->{data_type} || '';
2006 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
2010 return $bind_attributes;
2017 =item Arguments: $ident, $select, $condition, $attrs
2021 Handle a SQL select statement.
2027 my ($ident, $select, $condition, $attrs) = @_;
2028 return $self->cursor_class->new($self, \@_, $attrs);
2033 my ($rv, $sth, @bind) = $self->_select(@_);
2034 my @row = $sth->fetchrow_array;
2035 my @nextrow = $sth->fetchrow_array if @row;
2036 if(@row && @nextrow) {
2037 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2039 # Need to call finish() to work round broken DBDs
2048 =item Arguments: $sql
2052 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2057 my ($self, $dbh, $sql) = @_;
2059 # 3 is the if_active parameter which avoids active sth re-use
2060 my $sth = $self->disable_sth_caching
2061 ? $dbh->prepare($sql)
2062 : $dbh->prepare_cached($sql, {}, 3);
2064 # XXX You would think RaiseError would make this impossible,
2065 # but apparently that's not true :(
2066 $self->throw_exception($dbh->errstr) if !$sth;
2072 my ($self, $sql) = @_;
2073 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2076 sub _dbh_columns_info_for {
2077 my ($self, $dbh, $table) = @_;
2079 if ($dbh->can('column_info')) {
2083 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2084 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2086 while ( my $info = $sth->fetchrow_hashref() ){
2088 $column_info{data_type} = $info->{TYPE_NAME};
2089 $column_info{size} = $info->{COLUMN_SIZE};
2090 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2091 $column_info{default_value} = $info->{COLUMN_DEF};
2092 my $col_name = $info->{COLUMN_NAME};
2093 $col_name =~ s/^\"(.*)\"$/$1/;
2095 $result{$col_name} = \%column_info;
2100 return \%result if !$caught && scalar keys %result;
2104 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2106 my @columns = @{$sth->{NAME_lc}};
2107 for my $i ( 0 .. $#columns ){
2109 $column_info{data_type} = $sth->{TYPE}->[$i];
2110 $column_info{size} = $sth->{PRECISION}->[$i];
2111 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2113 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2114 $column_info{data_type} = $1;
2115 $column_info{size} = $2;
2118 $result{$columns[$i]} = \%column_info;
2122 foreach my $col (keys %result) {
2123 my $colinfo = $result{$col};
2124 my $type_num = $colinfo->{data_type};
2126 if(defined $type_num && $dbh->can('type_info')) {
2127 my $type_info = $dbh->type_info($type_num);
2128 $type_name = $type_info->{TYPE_NAME} if $type_info;
2129 $colinfo->{data_type} = $type_name if $type_name;
2136 sub columns_info_for {
2137 my ($self, $table) = @_;
2138 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2141 =head2 last_insert_id
2143 Return the row id of the last insert.
2147 sub _dbh_last_insert_id {
2148 my ($self, $dbh, $source, $col) = @_;
2150 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2152 return $id if defined $id;
2154 my $class = ref $self;
2155 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2158 sub last_insert_id {
2160 $self->_dbh_last_insert_id ($self->_dbh, @_);
2163 =head2 _native_data_type
2167 =item Arguments: $type_name
2171 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2172 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2173 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2175 The default implementation returns C<undef>, implement in your Storage driver if
2176 you need this functionality.
2178 Should map types from other databases to the native RDBMS type, for example
2179 C<VARCHAR2> to C<VARCHAR>.
2181 Types with modifiers should map to the underlying data type. For example,
2182 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2184 Composite types should map to the container type, for example
2185 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2189 sub _native_data_type {
2190 #my ($self, $data_type) = @_;
2194 # Check if placeholders are supported at all
2195 sub _placeholders_supported {
2197 my $dbh = $self->_get_dbh;
2199 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2200 # but it is inaccurate more often than not
2202 local $dbh->{PrintError} = 0;
2203 local $dbh->{RaiseError} = 1;
2204 $dbh->do('select ?', {}, 1);
2212 # Check if placeholders bound to non-string types throw exceptions
2214 sub _typeless_placeholders_supported {
2216 my $dbh = $self->_get_dbh;
2219 local $dbh->{PrintError} = 0;
2220 local $dbh->{RaiseError} = 1;
2221 # this specifically tests a bind that is NOT a string
2222 $dbh->do('select 1 where 1 = ?', {}, 1);
2232 Returns the database driver name.
2237 shift->_get_dbh->{Driver}->{Name};
2240 =head2 bind_attribute_by_data_type
2242 Given a datatype from column info, returns a database specific bind
2243 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2244 let the database planner just handle it.
2246 Generally only needed for special case column types, like bytea in postgres.
2250 sub bind_attribute_by_data_type {
2254 =head2 is_datatype_numeric
2256 Given a datatype from column_info, returns a boolean value indicating if
2257 the current RDBMS considers it a numeric value. This controls how
2258 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2259 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2260 be performed instead of the usual C<eq>.
2264 sub is_datatype_numeric {
2265 my ($self, $dt) = @_;
2267 return 0 unless $dt;
2269 return $dt =~ /^ (?:
2270 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2275 =head2 create_ddl_dir
2279 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2283 Creates a SQL file based on the Schema, for each of the specified
2284 database engines in C<\@databases> in the given directory.
2285 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2287 Given a previous version number, this will also create a file containing
2288 the ALTER TABLE statements to transform the previous schema into the
2289 current one. Note that these statements may contain C<DROP TABLE> or
2290 C<DROP COLUMN> statements that can potentially destroy data.
2292 The file names are created using the C<ddl_filename> method below, please
2293 override this method in your schema if you would like a different file
2294 name format. For the ALTER file, the same format is used, replacing
2295 $version in the name with "$preversion-$version".
2297 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2298 The most common value for this would be C<< { add_drop_table => 1 } >>
2299 to have the SQL produced include a C<DROP TABLE> statement for each table
2300 created. For quoting purposes supply C<quote_table_names> and
2301 C<quote_field_names>.
2303 If no arguments are passed, then the following default values are assumed:
2307 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2309 =item version - $schema->schema_version
2311 =item directory - './'
2313 =item preversion - <none>
2317 By default, C<\%sqlt_args> will have
2319 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2321 merged with the hash passed in. To disable any of those features, pass in a
2322 hashref like the following
2324 { ignore_constraint_names => 0, # ... other options }
2327 WARNING: You are strongly advised to check all SQL files created, before applying
2332 sub create_ddl_dir {
2333 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2336 carp "No directory given, using ./\n";
2341 make_path ("$dir") # make_path does not like objects (i.e. Path::Class::Dir)
2343 $self->throw_exception(
2344 "Failed to create '$dir': " . ($! || $@ || 'error unknow')
2348 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2350 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2351 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2353 my $schema_version = $schema->schema_version || '1.x';
2354 $version ||= $schema_version;
2357 add_drop_table => 1,
2358 ignore_constraint_names => 1,
2359 ignore_index_names => 1,
2363 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2364 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2367 my $sqlt = SQL::Translator->new( $sqltargs );
2369 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2370 my $sqlt_schema = $sqlt->translate({ data => $schema })
2371 or $self->throw_exception ($sqlt->error);
2373 foreach my $db (@$databases) {
2375 $sqlt->{schema} = $sqlt_schema;
2376 $sqlt->producer($db);
2379 my $filename = $schema->ddl_filename($db, $version, $dir);
2380 if (-e $filename && ($version eq $schema_version )) {
2381 # if we are dumping the current version, overwrite the DDL
2382 carp "Overwriting existing DDL file - $filename";
2386 my $output = $sqlt->translate;
2388 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2391 if(!open($file, ">$filename")) {
2392 $self->throw_exception("Can't open $filename for writing ($!)");
2395 print $file $output;
2398 next unless ($preversion);
2400 require SQL::Translator::Diff;
2402 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2403 if(!-e $prefilename) {
2404 carp("No previous schema file found ($prefilename)");
2408 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2410 carp("Overwriting existing diff file - $difffile");
2416 my $t = SQL::Translator->new($sqltargs);
2421 or $self->throw_exception ($t->error);
2423 my $out = $t->translate( $prefilename )
2424 or $self->throw_exception ($t->error);
2426 $source_schema = $t->schema;
2428 $source_schema->name( $prefilename )
2429 unless ( $source_schema->name );
2432 # The "new" style of producers have sane normalization and can support
2433 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2434 # And we have to diff parsed SQL against parsed SQL.
2435 my $dest_schema = $sqlt_schema;
2437 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2438 my $t = SQL::Translator->new($sqltargs);
2443 or $self->throw_exception ($t->error);
2445 my $out = $t->translate( $filename )
2446 or $self->throw_exception ($t->error);
2448 $dest_schema = $t->schema;
2450 $dest_schema->name( $filename )
2451 unless $dest_schema->name;
2454 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2458 if(!open $file, ">$difffile") {
2459 $self->throw_exception("Can't write to $difffile ($!)");
2467 =head2 deployment_statements
2471 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2475 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2477 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2478 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2480 C<$directory> is used to return statements from files in a previously created
2481 L</create_ddl_dir> directory and is optional. The filenames are constructed
2482 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2484 If no C<$directory> is specified then the statements are constructed on the
2485 fly using L<SQL::Translator> and C<$version> is ignored.
2487 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2491 sub deployment_statements {
2492 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2493 $type ||= $self->sqlt_type;
2494 $version ||= $schema->schema_version || '1.x';
2496 my $filename = $schema->ddl_filename($type, $version, $dir);
2500 open($file, "<$filename")
2501 or $self->throw_exception("Can't open $filename ($!)");
2504 return join('', @rows);
2507 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2508 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2511 # sources needs to be a parser arg, but for simplicty allow at top level
2513 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2514 if exists $sqltargs->{sources};
2516 my $tr = SQL::Translator->new(
2517 producer => "SQL::Translator::Producer::${type}",
2519 parser => 'SQL::Translator::Parser::DBIx::Class',
2526 @ret = $tr->translate;
2529 $ret[0] = $tr->translate;
2532 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2533 unless (@ret && defined $ret[0]);
2535 return $wa ? @ret : $ret[0];
2539 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2542 return if($line =~ /^--/);
2544 # next if($line =~ /^DROP/m);
2545 return if($line =~ /^BEGIN TRANSACTION/m);
2546 return if($line =~ /^COMMIT/m);
2547 return if $line =~ /^\s+$/; # skip whitespace only
2548 $self->_query_start($line);
2550 # do a dbh_do cycle here, as we need some error checking in
2551 # place (even though we will ignore errors)
2552 $self->dbh_do (sub { $_[1]->do($line) });
2554 carp qq{$_ (running "${line}")};
2556 $self->_query_end($line);
2558 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2559 if (@statements > 1) {
2560 foreach my $statement (@statements) {
2561 $deploy->( $statement );
2564 elsif (@statements == 1) {
2565 foreach my $line ( split(";\n", $statements[0])) {
2571 =head2 datetime_parser
2573 Returns the datetime parser class
2577 sub datetime_parser {
2579 return $self->{datetime_parser} ||= do {
2580 $self->build_datetime_parser(@_);
2584 =head2 datetime_parser_type
2586 Defines (returns) the datetime parser class - currently hardwired to
2587 L<DateTime::Format::MySQL>
2591 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2593 =head2 build_datetime_parser
2595 See L</datetime_parser>
2599 sub build_datetime_parser {
2601 my $type = $self->datetime_parser_type(@_);
2602 $self->ensure_class_loaded ($type);
2607 =head2 is_replicating
2609 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2610 replicate from a master database. Default is undef, which is the result
2611 returned by databases that don't support replication.
2615 sub is_replicating {
2620 =head2 lag_behind_master
2622 Returns a number that represents a certain amount of lag behind a master db
2623 when a given storage is replicating. The number is database dependent, but
2624 starts at zero and increases with the amount of lag. Default in undef
2628 sub lag_behind_master {
2632 =head2 relname_to_table_alias
2636 =item Arguments: $relname, $join_count
2640 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2643 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2644 way these aliases are named.
2646 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2647 otherwise C<"$relname">.
2651 sub relname_to_table_alias {
2652 my ($self, $relname, $join_count) = @_;
2654 my $alias = ($join_count && $join_count > 1 ?
2655 join('_', $relname, $join_count) : $relname);
2664 =head2 DBIx::Class and AutoCommit
2666 DBIx::Class can do some wonderful magic with handling exceptions,
2667 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2668 (the default) combined with C<txn_do> for transaction support.
2670 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2671 in an assumed transaction between commits, and you're telling us you'd
2672 like to manage that manually. A lot of the magic protections offered by
2673 this module will go away. We can't protect you from exceptions due to database
2674 disconnects because we don't know anything about how to restart your
2675 transactions. You're on your own for handling all sorts of exceptional
2676 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2682 Matt S. Trout <mst@shadowcatsystems.co.uk>
2684 Andy Grundman <andy@hybridized.org>
2688 You may distribute this code under the same terms as Perl itself.