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;
16 use Data::Dumper::Concise();
22 __PACKAGE__->mk_group_accessors('simple' => qw/
23 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
24 _dbh _server_info_hash _conn_pid _conn_tid _sql_maker _sql_maker_opts
25 transaction_depth _dbh_autocommit savepoints
28 # the values for these accessors are picked out (and deleted) from
29 # the attribute hashref passed to connect_info
30 my @storage_options = qw/
31 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
32 disable_sth_caching unsafe auto_savepoint
34 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
37 # default cursor class, overridable in connect_info attributes
38 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
40 __PACKAGE__->mk_group_accessors('inherited' => qw/
42 _supports_insert_returning
44 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
46 # Each of these methods need _determine_driver called before itself
47 # in order to function reliably. This is a purely DRY optimization
48 my @rdbms_specific_methods = qw/
63 for my $meth (@rdbms_specific_methods) {
65 my $orig = __PACKAGE__->can ($meth)
69 no warnings qw/redefine/;
70 *{__PACKAGE__ ."::$meth"} = Sub::Name::subname $meth => sub {
71 if (not $_[0]->_driver_determined) {
72 $_[0]->_determine_driver;
73 goto $_[0]->can($meth);
82 DBIx::Class::Storage::DBI - DBI storage handler
86 my $schema = MySchema->connect('dbi:SQLite:my.db');
88 $schema->storage->debug(1);
90 my @stuff = $schema->storage->dbh_do(
92 my ($storage, $dbh, @args) = @_;
93 $dbh->do("DROP TABLE authors");
98 $schema->resultset('Book')->search({
99 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
104 This class represents the connection to an RDBMS via L<DBI>. See
105 L<DBIx::Class::Storage> for general information. This pod only
106 documents DBI-specific methods and behaviors.
113 my $new = shift->next::method(@_);
115 $new->transaction_depth(0);
116 $new->_sql_maker_opts({});
117 $new->{savepoints} = [];
118 $new->{_in_dbh_do} = 0;
119 $new->{_dbh_gen} = 0;
121 # read below to see what this does
122 $new->_arm_global_destructor;
127 # This is hack to work around perl shooting stuff in random
128 # order on exit(). If we do not walk the remaining storage
129 # objects in an END block, there is a *small but real* chance
130 # of a fork()ed child to kill the parent's shared DBI handle,
131 # *before perl reaches the DESTROY in this package*
132 # Yes, it is ugly and effective.
134 my %seek_and_destroy;
136 sub _arm_global_destructor {
138 my $key = Scalar::Util::refaddr ($self);
139 $seek_and_destroy{$key} = $self;
140 Scalar::Util::weaken ($seek_and_destroy{$key});
144 local $?; # just in case the DBI destructor changes it somehow
146 # destroy just the object if not native to this process/thread
147 $_->_preserve_foreign_dbh for (grep
149 values %seek_and_destroy
157 # destroy just the object if not native to this process/thread
158 $self->_preserve_foreign_dbh;
160 # some databases need this to stop spewing warnings
161 if (my $dbh = $self->_dbh) {
163 %{ $dbh->{CachedKids} } = ();
171 sub _preserve_foreign_dbh {
174 return unless $self->_dbh;
178 return unless $self->_dbh;
184 # handle pid changes correctly - do not destroy parent's connection
188 return if ( defined $self->_conn_pid and $self->_conn_pid == $$ );
190 $self->_dbh->{InactiveDestroy} = 1;
197 # very similar to above, but seems to FAIL if I set InactiveDestroy
201 if ( ! defined $self->_conn_tid ) {
204 elsif ( $self->_conn_tid == threads->tid ) {
205 return; # same thread
208 #$self->_dbh->{InactiveDestroy} = 1; # why does t/51threads.t fail...?
218 This method is normally called by L<DBIx::Class::Schema/connection>, which
219 encapsulates its argument list in an arrayref before passing them here.
221 The argument list may contain:
227 The same 4-element argument set one would normally pass to
228 L<DBI/connect>, optionally followed by
229 L<extra attributes|/DBIx::Class specific connection attributes>
230 recognized by DBIx::Class:
232 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
236 A single code reference which returns a connected
237 L<DBI database handle|DBI/connect> optionally followed by
238 L<extra attributes|/DBIx::Class specific connection attributes> recognized
241 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
245 A single hashref with all the attributes and the dsn/user/password
248 $connect_info_args = [{
256 $connect_info_args = [{
257 dbh_maker => sub { DBI->connect (...) },
262 This is particularly useful for L<Catalyst> based applications, allowing the
263 following config (L<Config::General> style):
268 dsn dbi:mysql:database=test
275 The C<dsn>/C<user>/C<password> combination can be substituted by the
276 C<dbh_maker> key whose value is a coderef that returns a connected
277 L<DBI database handle|DBI/connect>
281 Please note that the L<DBI> docs recommend that you always explicitly
282 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
283 recommends that it be set to I<1>, and that you perform transactions
284 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
285 to I<1> if you do not do explicitly set it to zero. This is the default
286 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
288 =head3 DBIx::Class specific connection attributes
290 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
291 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
292 the following connection options. These options can be mixed in with your other
293 L<DBI> connection attributes, or placed in a separate hashref
294 (C<\%extra_attributes>) as shown above.
296 Every time C<connect_info> is invoked, any previous settings for
297 these options will be cleared before setting the new ones, regardless of
298 whether any options are specified in the new C<connect_info>.
305 Specifies things to do immediately after connecting or re-connecting to
306 the database. Its value may contain:
312 This contains one SQL statement to execute.
314 =item an array reference
316 This contains SQL statements to execute in order. Each element contains
317 a string or a code reference that returns a string.
319 =item a code reference
321 This contains some code to execute. Unlike code references within an
322 array reference, its return value is ignored.
326 =item on_disconnect_do
328 Takes arguments in the same form as L</on_connect_do> and executes them
329 immediately before disconnecting from the database.
331 Note, this only runs if you explicitly call L</disconnect> on the
334 =item on_connect_call
336 A more generalized form of L</on_connect_do> that calls the specified
337 C<connect_call_METHOD> methods in your storage driver.
339 on_connect_do => 'select 1'
343 on_connect_call => [ [ do_sql => 'select 1' ] ]
345 Its values may contain:
351 Will call the C<connect_call_METHOD> method.
353 =item a code reference
355 Will execute C<< $code->($storage) >>
357 =item an array reference
359 Each value can be a method name or code reference.
361 =item an array of arrays
363 For each array, the first item is taken to be the C<connect_call_> method name
364 or code reference, and the rest are parameters to it.
368 Some predefined storage methods you may use:
374 Executes a SQL string or a code reference that returns a SQL string. This is
375 what L</on_connect_do> and L</on_disconnect_do> use.
383 Will execute the scalar as SQL.
387 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
388 attributes hashref and bind values.
390 =item a code reference
392 Will execute C<< $code->($storage) >> and execute the return array refs as
399 Execute any statements necessary to initialize the database session to return
400 and accept datetime/timestamp values used with
401 L<DBIx::Class::InflateColumn::DateTime>.
403 Only necessary for some databases, see your specific storage driver for
404 implementation details.
408 =item on_disconnect_call
410 Takes arguments in the same form as L</on_connect_call> and executes them
411 immediately before disconnecting from the database.
413 Calls the C<disconnect_call_METHOD> methods as opposed to the
414 C<connect_call_METHOD> methods called by L</on_connect_call>.
416 Note, this only runs if you explicitly call L</disconnect> on the
419 =item disable_sth_caching
421 If set to a true value, this option will disable the caching of
422 statement handles via L<DBI/prepare_cached>.
426 Sets the limit dialect. This is useful for JDBC-bridge among others
427 where the remote SQL-dialect cannot be determined by the name of the
428 driver alone. See also L<SQL::Abstract::Limit>.
432 Specifies what characters to use to quote table and column names. If
433 you use this you will want to specify L</name_sep> as well.
435 C<quote_char> expects either a single character, in which case is it
436 is placed on either side of the table/column name, or an arrayref of length
437 2 in which case the table/column name is placed between the elements.
439 For example under MySQL you should use C<< quote_char => '`' >>, and for
440 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
444 This only needs to be used in conjunction with C<quote_char>, and is used to
445 specify the character that separates elements (schemas, tables, columns) from
446 each other. In most cases this is simply a C<.>.
448 The consequences of not supplying this value is that L<SQL::Abstract>
449 will assume DBIx::Class' uses of aliases to be complete column
450 names. The output will look like I<"me.name"> when it should actually
455 This Storage driver normally installs its own C<HandleError>, sets
456 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
457 all database handles, including those supplied by a coderef. It does this
458 so that it can have consistent and useful error behavior.
460 If you set this option to a true value, Storage will not do its usual
461 modifications to the database handle's attributes, and instead relies on
462 the settings in your connect_info DBI options (or the values you set in
463 your connection coderef, in the case that you are connecting via coderef).
465 Note that your custom settings can cause Storage to malfunction,
466 especially if you set a C<HandleError> handler that suppresses exceptions
467 and/or disable C<RaiseError>.
471 If this option is true, L<DBIx::Class> will use savepoints when nesting
472 transactions, making it possible to recover from failure in the inner
473 transaction without having to abort all outer transactions.
477 Use this argument to supply a cursor class other than the default
478 L<DBIx::Class::Storage::DBI::Cursor>.
482 Some real-life examples of arguments to L</connect_info> and
483 L<DBIx::Class::Schema/connect>
485 # Simple SQLite connection
486 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
489 ->connect_info([ sub { DBI->connect(...) } ]);
491 # Connect via subref in hashref
493 dbh_maker => sub { DBI->connect(...) },
494 on_connect_do => 'alter session ...',
497 # A bit more complicated
504 { quote_char => q{"}, name_sep => q{.} },
508 # Equivalent to the previous example
514 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
518 # Same, but with hashref as argument
519 # See parse_connect_info for explanation
522 dsn => 'dbi:Pg:dbname=foo',
524 password => 'my_pg_password',
531 # Subref + DBIx::Class-specific connection options
534 sub { DBI->connect(...) },
538 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
539 disable_sth_caching => 1,
549 my ($self, $info) = @_;
551 return $self->_connect_info if !$info;
553 $self->_connect_info($info); # copy for _connect_info
555 $info = $self->_normalize_connect_info($info)
556 if ref $info eq 'ARRAY';
558 for my $storage_opt (keys %{ $info->{storage_options} }) {
559 my $value = $info->{storage_options}{$storage_opt};
561 $self->$storage_opt($value);
564 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
565 # the new set of options
566 $self->_sql_maker(undef);
567 $self->_sql_maker_opts({});
569 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
570 my $value = $info->{sql_maker_options}{$sql_maker_opt};
572 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
576 %{ $self->_default_dbi_connect_attributes || {} },
577 %{ $info->{attributes} || {} },
580 my @args = @{ $info->{arguments} };
582 $self->_dbi_connect_info([@args,
583 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
586 # save attributes them in a separate accessor so they are always
587 # introspectable, even in case of a CODE $dbhmaker
588 $self->_dbic_connect_attributes (\%attrs);
590 return $self->_connect_info;
593 sub _normalize_connect_info {
594 my ($self, $info_arg) = @_;
597 my @args = @$info_arg; # take a shallow copy for further mutilation
599 # combine/pre-parse arguments depending on invocation style
602 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
603 %attrs = %{ $args[1] || {} };
606 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
607 %attrs = %{$args[0]};
609 if (my $code = delete $attrs{dbh_maker}) {
612 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
615 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
616 . "to the result of 'dbh_maker'",
618 join (', ', map { "'$_'" } (@ignored) ),
623 @args = delete @attrs{qw/dsn user password/};
626 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
628 % { $args[3] || {} },
629 % { $args[4] || {} },
631 @args = @args[0,1,2];
634 $info{arguments} = \@args;
636 my @storage_opts = grep exists $attrs{$_},
637 @storage_options, 'cursor_class';
639 @{ $info{storage_options} }{@storage_opts} =
640 delete @attrs{@storage_opts} if @storage_opts;
642 my @sql_maker_opts = grep exists $attrs{$_},
643 qw/limit_dialect quote_char name_sep/;
645 @{ $info{sql_maker_options} }{@sql_maker_opts} =
646 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
648 $info{attributes} = \%attrs if %attrs;
653 sub _default_dbi_connect_attributes {
663 This method is deprecated in favour of setting via L</connect_info>.
667 =head2 on_disconnect_do
669 This method is deprecated in favour of setting via L</connect_info>.
673 sub _parse_connect_do {
674 my ($self, $type) = @_;
676 my $val = $self->$type;
677 return () if not defined $val;
682 push @res, [ 'do_sql', $val ];
683 } elsif (ref($val) eq 'CODE') {
685 } elsif (ref($val) eq 'ARRAY') {
686 push @res, map { [ 'do_sql', $_ ] } @$val;
688 $self->throw_exception("Invalid type for $type: ".ref($val));
696 Arguments: ($subref | $method_name), @extra_coderef_args?
698 Execute the given $subref or $method_name using the new exception-based
699 connection management.
701 The first two arguments will be the storage object that C<dbh_do> was called
702 on and a database handle to use. Any additional arguments will be passed
703 verbatim to the called subref as arguments 2 and onwards.
705 Using this (instead of $self->_dbh or $self->dbh) ensures correct
706 exception handling and reconnection (or failover in future subclasses).
708 Your subref should have no side-effects outside of the database, as
709 there is the potential for your subref to be partially double-executed
710 if the database connection was stale/dysfunctional.
714 my @stuff = $schema->storage->dbh_do(
716 my ($storage, $dbh, @cols) = @_;
717 my $cols = join(q{, }, @cols);
718 $dbh->selectrow_array("SELECT $cols FROM foo");
729 my $dbh = $self->_get_dbh;
731 return $self->$code($dbh, @_)
732 if ( $self->{_in_dbh_do} || $self->{transaction_depth} );
734 local $self->{_in_dbh_do} = 1;
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;
778 @result = $coderef->(@args);
780 elsif(defined $want_array) {
781 $result[0] = $coderef->(@args);
791 if(! defined $exception) { return $want_array ? @result : $result[0] }
793 if($tried++ || $self->connected) {
794 my $rollback_exception;
795 try { $self->txn_rollback } catch { $rollback_exception = shift };
796 if(defined $rollback_exception) {
797 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
798 $self->throw_exception($exception) # propagate nested rollback
799 if $rollback_exception =~ /$exception_class/;
801 $self->throw_exception(
802 "Transaction aborted: ${exception}. "
803 . "Rollback failed: ${rollback_exception}"
806 $self->throw_exception($exception)
809 # We were not connected, and was first try - reconnect and retry
811 carp "Retrying $coderef after catching disconnected exception: $exception"
812 if $ENV{DBIC_DBIRETRY_DEBUG};
813 $self->_populate_dbh;
819 Our C<disconnect> method also performs a rollback first if the
820 database is not in C<AutoCommit> mode.
830 push @actions, ( $self->on_disconnect_call || () );
831 push @actions, $self->_parse_connect_do ('on_disconnect_do');
833 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
835 $self->_dbh_rollback unless $self->_dbh_autocommit;
837 %{ $self->_dbh->{CachedKids} } = ();
838 $self->_dbh->disconnect;
844 =head2 with_deferred_fk_checks
848 =item Arguments: C<$coderef>
850 =item Return Value: The return value of $coderef
854 Storage specific method to run the code ref with FK checks deferred or
855 in MySQL's case disabled entirely.
859 # Storage subclasses should override this
860 sub with_deferred_fk_checks {
861 my ($self, $sub) = @_;
869 =item Arguments: none
871 =item Return Value: 1|0
875 Verifies that the current database handle is active and ready to execute
876 an SQL statement (e.g. the connection did not get stale, server is still
877 answering, etc.) This method is used internally by L</dbh>.
883 return 0 unless $self->_seems_connected;
886 local $self->_dbh->{RaiseError} = 1;
891 sub _seems_connected {
894 $self->_preserve_foreign_dbh;
896 my $dbh = $self->_dbh
899 return $dbh->FETCH('Active');
905 my $dbh = $self->_dbh or return 0;
910 sub ensure_connected {
913 unless ($self->connected) {
914 $self->_populate_dbh;
920 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
921 is guaranteed to be healthy by implicitly calling L</connected>, and if
922 necessary performing a reconnection before returning. Keep in mind that this
923 is very B<expensive> on some database engines. Consider using L</dbh_do>
931 if (not $self->_dbh) {
932 $self->_populate_dbh;
934 $self->ensure_connected;
939 # this is the internal "get dbh or connect (don't check)" method
942 $self->_preserve_foreign_dbh;
943 $self->_populate_dbh unless $self->_dbh;
947 sub _sql_maker_args {
952 array_datatypes => 1,
953 limit_dialect => $self->_get_dbh,
954 %{$self->_sql_maker_opts}
960 unless ($self->_sql_maker) {
961 my $sql_maker_class = $self->sql_maker_class;
962 $self->ensure_class_loaded ($sql_maker_class);
963 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
965 return $self->_sql_maker;
968 # nothing to do by default
975 my @info = @{$self->_dbi_connect_info || []};
976 $self->_dbh(undef); # in case ->connected failed we might get sent here
977 $self->_server_info_hash (undef);
978 $self->_dbh($self->_connect(@info));
980 $self->_conn_pid($$);
981 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
983 $self->_determine_driver;
985 # Always set the transaction depth on connect, since
986 # there is no transaction in progress by definition
987 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
989 $self->_run_connection_actions unless $self->{_in_determine_driver};
992 sub _run_connection_actions {
996 push @actions, ( $self->on_connect_call || () );
997 push @actions, $self->_parse_connect_do ('on_connect_do');
999 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1005 unless ($self->_server_info_hash) {
1009 my $server_version = try { $self->_get_server_version };
1011 if (defined $server_version) {
1012 $info{dbms_version} = $server_version;
1014 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1015 my @verparts = split (/\./, $numeric_version);
1021 # consider only up to 3 version parts, iff not more than 3 digits
1023 while (@verparts && @use_parts < 3) {
1024 my $p = shift @verparts;
1026 push @use_parts, $p;
1028 push @use_parts, 0 while @use_parts < 3;
1030 $info{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1034 $self->_server_info_hash(\%info);
1037 return $self->_server_info_hash
1040 sub _get_server_version {
1041 shift->_get_dbh->get_info(18);
1044 sub _determine_driver {
1047 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1048 my $started_connected = 0;
1049 local $self->{_in_determine_driver} = 1;
1051 if (ref($self) eq __PACKAGE__) {
1053 if ($self->_dbh) { # we are connected
1054 $driver = $self->_dbh->{Driver}{Name};
1055 $started_connected = 1;
1057 # if connect_info is a CODEREF, we have no choice but to connect
1058 if (ref $self->_dbi_connect_info->[0] &&
1059 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
1060 $self->_populate_dbh;
1061 $driver = $self->_dbh->{Driver}{Name};
1064 # try to use dsn to not require being connected, the driver may still
1065 # force a connection in _rebless to determine version
1066 # (dsn may not be supplied at all if all we do is make a mock-schema)
1067 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1068 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1069 $driver ||= $ENV{DBI_DRIVER};
1074 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1075 if ($self->load_optional_class($storage_class)) {
1076 mro::set_mro($storage_class, 'c3');
1077 bless $self, $storage_class;
1083 $self->_driver_determined(1);
1085 $self->_init; # run driver-specific initializations
1087 $self->_run_connection_actions
1088 if !$started_connected && defined $self->_dbh;
1092 sub _do_connection_actions {
1094 my $method_prefix = shift;
1097 if (not ref($call)) {
1098 my $method = $method_prefix . $call;
1100 } elsif (ref($call) eq 'CODE') {
1102 } elsif (ref($call) eq 'ARRAY') {
1103 if (ref($call->[0]) ne 'ARRAY') {
1104 $self->_do_connection_actions($method_prefix, $_) for @$call;
1106 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1109 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1115 sub connect_call_do_sql {
1117 $self->_do_query(@_);
1120 sub disconnect_call_do_sql {
1122 $self->_do_query(@_);
1125 # override in db-specific backend when necessary
1126 sub connect_call_datetime_setup { 1 }
1129 my ($self, $action) = @_;
1131 if (ref $action eq 'CODE') {
1132 $action = $action->($self);
1133 $self->_do_query($_) foreach @$action;
1136 # Most debuggers expect ($sql, @bind), so we need to exclude
1137 # the attribute hash which is the second argument to $dbh->do
1138 # furthermore the bind values are usually to be presented
1139 # as named arrayref pairs, so wrap those here too
1140 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1141 my $sql = shift @do_args;
1142 my $attrs = shift @do_args;
1143 my @bind = map { [ undef, $_ ] } @do_args;
1145 $self->_query_start($sql, @bind);
1146 $self->_get_dbh->do($sql, $attrs, @do_args);
1147 $self->_query_end($sql, @bind);
1154 my ($self, @info) = @_;
1156 $self->throw_exception("You failed to provide any connection info")
1159 my ($old_connect_via, $dbh);
1161 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1162 $old_connect_via = $DBI::connect_via;
1163 $DBI::connect_via = 'connect';
1167 if(ref $info[0] eq 'CODE') {
1168 $dbh = $info[0]->();
1171 $dbh = DBI->connect(@info);
1178 unless ($self->unsafe) {
1179 my $weak_self = $self;
1180 Scalar::Util::weaken($weak_self);
1181 $dbh->{HandleError} = sub {
1183 $weak_self->throw_exception("DBI Exception: $_[0]");
1186 # the handler may be invoked by something totally out of
1188 croak ("DBI Exception: $_[0]");
1191 $dbh->{ShowErrorStatement} = 1;
1192 $dbh->{RaiseError} = 1;
1193 $dbh->{PrintError} = 0;
1197 $self->throw_exception("DBI Connection failed: $_")
1200 $DBI::connect_via = $old_connect_via if $old_connect_via;
1203 $self->_dbh_autocommit($dbh->{AutoCommit});
1208 my ($self, $name) = @_;
1210 $name = $self->_svp_generate_name
1211 unless defined $name;
1213 $self->throw_exception ("You can't use savepoints outside a transaction")
1214 if $self->{transaction_depth} == 0;
1216 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1217 unless $self->can('_svp_begin');
1219 push @{ $self->{savepoints} }, $name;
1221 $self->debugobj->svp_begin($name) if $self->debug;
1223 return $self->_svp_begin($name);
1227 my ($self, $name) = @_;
1229 $self->throw_exception ("You can't use savepoints outside a transaction")
1230 if $self->{transaction_depth} == 0;
1232 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1233 unless $self->can('_svp_release');
1235 if (defined $name) {
1236 $self->throw_exception ("Savepoint '$name' does not exist")
1237 unless grep { $_ eq $name } @{ $self->{savepoints} };
1239 # Dig through the stack until we find the one we are releasing. This keeps
1240 # the stack up to date.
1243 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1245 $name = pop @{ $self->{savepoints} };
1248 $self->debugobj->svp_release($name) if $self->debug;
1250 return $self->_svp_release($name);
1254 my ($self, $name) = @_;
1256 $self->throw_exception ("You can't use savepoints outside a transaction")
1257 if $self->{transaction_depth} == 0;
1259 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1260 unless $self->can('_svp_rollback');
1262 if (defined $name) {
1263 # If they passed us a name, verify that it exists in the stack
1264 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1265 $self->throw_exception("Savepoint '$name' does not exist!");
1268 # Dig through the stack until we find the one we are releasing. This keeps
1269 # the stack up to date.
1270 while(my $s = pop(@{ $self->{savepoints} })) {
1271 last if($s eq $name);
1273 # Add the savepoint back to the stack, as a rollback doesn't remove the
1274 # named savepoint, only everything after it.
1275 push(@{ $self->{savepoints} }, $name);
1277 # We'll assume they want to rollback to the last savepoint
1278 $name = $self->{savepoints}->[-1];
1281 $self->debugobj->svp_rollback($name) if $self->debug;
1283 return $self->_svp_rollback($name);
1286 sub _svp_generate_name {
1289 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1295 # this means we have not yet connected and do not know the AC status
1296 # (e.g. coderef $dbh)
1297 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1299 if($self->{transaction_depth} == 0) {
1300 $self->debugobj->txn_begin()
1302 $self->_dbh_begin_work;
1304 elsif ($self->auto_savepoint) {
1307 $self->{transaction_depth}++;
1310 sub _dbh_begin_work {
1313 # if the user is utilizing txn_do - good for him, otherwise we need to
1314 # ensure that the $dbh is healthy on BEGIN.
1315 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1316 # will be replaced by a failure of begin_work itself (which will be
1317 # then retried on reconnect)
1318 if ($self->{_in_dbh_do}) {
1319 $self->_dbh->begin_work;
1321 $self->dbh_do(sub { $_[1]->begin_work });
1327 if ($self->{transaction_depth} == 1) {
1328 $self->debugobj->txn_commit()
1331 $self->{transaction_depth} = 0
1332 if $self->_dbh_autocommit;
1334 elsif($self->{transaction_depth} > 1) {
1335 $self->{transaction_depth}--;
1337 if $self->auto_savepoint;
1343 my $dbh = $self->_dbh
1344 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1350 my $dbh = $self->_dbh;
1352 if ($self->{transaction_depth} == 1) {
1353 $self->debugobj->txn_rollback()
1355 $self->{transaction_depth} = 0
1356 if $self->_dbh_autocommit;
1357 $self->_dbh_rollback;
1359 elsif($self->{transaction_depth} > 1) {
1360 $self->{transaction_depth}--;
1361 if ($self->auto_savepoint) {
1362 $self->svp_rollback;
1367 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1371 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1373 if ($_ !~ /$exception_class/) {
1374 # ensure that a failed rollback resets the transaction depth
1375 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1378 $self->throw_exception($_)
1384 my $dbh = $self->_dbh
1385 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1389 # This used to be the top-half of _execute. It was split out to make it
1390 # easier to override in NoBindVars without duping the rest. It takes up
1391 # all of _execute's args, and emits $sql, @bind.
1392 sub _prep_for_execute {
1393 my ($self, $op, $extra_bind, $ident, $args) = @_;
1395 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1396 $ident = $ident->from();
1399 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1402 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1404 return ($sql, \@bind);
1408 sub _fix_bind_params {
1409 my ($self, @bind) = @_;
1411 ### Turn @bind from something like this:
1412 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1414 ### ( "'1'", "'1'", "'3'" )
1417 if ( defined( $_ && $_->[1] ) ) {
1418 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1425 my ( $self, $sql, @bind ) = @_;
1427 if ( $self->debug ) {
1428 @bind = $self->_fix_bind_params(@bind);
1430 $self->debugobj->query_start( $sql, @bind );
1435 my ( $self, $sql, @bind ) = @_;
1437 if ( $self->debug ) {
1438 @bind = $self->_fix_bind_params(@bind);
1439 $self->debugobj->query_end( $sql, @bind );
1444 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1446 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1448 $self->_query_start( $sql, @$bind );
1450 my $sth = $self->sth($sql,$op);
1452 my $placeholder_index = 1;
1454 foreach my $bound (@$bind) {
1455 my $attributes = {};
1456 my($column_name, @data) = @$bound;
1458 if ($bind_attributes) {
1459 $attributes = $bind_attributes->{$column_name}
1460 if defined $bind_attributes->{$column_name};
1463 foreach my $data (@data) {
1464 my $ref = ref $data;
1465 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1467 $sth->bind_param($placeholder_index, $data, $attributes);
1468 $placeholder_index++;
1472 # Can this fail without throwing an exception anyways???
1473 my $rv = $sth->execute();
1474 $self->throw_exception(
1475 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1478 $self->_query_end( $sql, @$bind );
1480 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1485 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1488 sub _prefetch_insert_auto_nextvals {
1489 my ($self, $source, $to_insert) = @_;
1493 foreach my $col ( $source->columns ) {
1494 if ( !defined $to_insert->{$col} ) {
1495 my $col_info = $source->column_info($col);
1497 if ( $col_info->{auto_nextval} ) {
1498 $upd->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1500 $col_info->{sequence} ||=
1501 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1512 my ($source, $to_insert, $opts) = @_;
1514 my $updated_cols = $self->_prefetch_insert_auto_nextvals (@_);
1516 my $bind_attributes = $self->source_bind_attributes($source);
1518 my ($rv, $sth) = $self->_execute('insert' => [], $source, $bind_attributes, $to_insert, $opts);
1520 if ($opts->{returning}) {
1521 my @ret_cols = @{$opts->{returning}};
1523 my @ret_vals = try {
1524 local $SIG{__WARN__} = sub {};
1525 my @r = $sth->fetchrow_array;
1531 @ret{@ret_cols} = @ret_vals if (@ret_vals);
1539 return $updated_cols;
1542 ## Currently it is assumed that all values passed will be "normal", i.e. not
1543 ## scalar refs, or at least, all the same type as the first set, the statement is
1544 ## only prepped once.
1546 my ($self, $source, $cols, $data) = @_;
1549 @colvalues{@$cols} = (0..$#$cols);
1551 for my $i (0..$#$cols) {
1552 my $first_val = $data->[0][$i];
1553 next unless ref $first_val eq 'SCALAR';
1555 $colvalues{ $cols->[$i] } = $first_val;
1558 # check for bad data and stringify stringifiable objects
1559 my $bad_slice = sub {
1560 my ($msg, $col_idx, $slice_idx) = @_;
1561 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1565 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1566 Data::Dumper::Concise::Dumper({
1567 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1573 for my $datum_idx (0..$#$data) {
1574 my $datum = $data->[$datum_idx];
1576 for my $col_idx (0..$#$cols) {
1577 my $val = $datum->[$col_idx];
1578 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1579 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1581 if ($is_literal_sql) {
1583 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1585 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1586 $bad_slice->("$reftype reference found where literal SQL expected",
1587 $col_idx, $datum_idx);
1589 elsif ($$val ne $$sqla_bind){
1590 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1591 $col_idx, $datum_idx);
1594 elsif (my $reftype = ref $val) {
1596 if (overload::Method($val, '""')) {
1597 $datum->[$col_idx] = "".$val;
1600 $bad_slice->("$reftype reference found where bind expected",
1601 $col_idx, $datum_idx);
1607 my ($sql, $bind) = $self->_prep_for_execute (
1608 'insert', undef, $source, [\%colvalues]
1612 my $empty_bind = 1 if (not @bind) &&
1613 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1615 if ((not @bind) && (not $empty_bind)) {
1616 $self->throw_exception(
1617 'Cannot insert_bulk without support for placeholders'
1621 # neither _execute_array, nor _execute_inserts_with_no_binds are
1622 # atomic (even if _execute _array is a single call). Thus a safety
1624 my $guard = $self->txn_scope_guard;
1626 $self->_query_start( $sql, ['__BULK__'] );
1627 my $sth = $self->sth($sql);
1630 # bind_param_array doesn't work if there are no binds
1631 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1634 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1635 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1639 $self->_query_end( $sql, ['__BULK__'] );
1643 return (wantarray ? ($rv, $sth, @bind) : $rv);
1646 sub _execute_array {
1647 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1649 ## This must be an arrayref, else nothing works!
1650 my $tuple_status = [];
1652 ## Get the bind_attributes, if any exist
1653 my $bind_attributes = $self->source_bind_attributes($source);
1655 ## Bind the values and execute
1656 my $placeholder_index = 1;
1658 foreach my $bound (@$bind) {
1660 my $attributes = {};
1661 my ($column_name, $data_index) = @$bound;
1663 if( $bind_attributes ) {
1664 $attributes = $bind_attributes->{$column_name}
1665 if defined $bind_attributes->{$column_name};
1668 my @data = map { $_->[$data_index] } @$data;
1670 $sth->bind_param_array(
1673 (%$attributes ? $attributes : ()),
1675 $placeholder_index++;
1680 $rv = $self->_dbh_execute_array($sth, $tuple_status, @extra);
1686 # Statement must finish even if there was an exception.
1691 $err = shift unless defined $err
1696 if (! defined $err and $sth->err);
1700 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1702 $self->throw_exception("Unexpected populate error: $err")
1703 if ($i > $#$tuple_status);
1705 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1706 ($tuple_status->[$i][1] || $err),
1707 Data::Dumper::Concise::Dumper({
1708 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1716 sub _dbh_execute_array {
1717 my ($self, $sth, $tuple_status, @extra) = @_;
1719 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1722 sub _dbh_execute_inserts_with_no_binds {
1723 my ($self, $sth, $count) = @_;
1727 my $dbh = $self->_get_dbh;
1728 local $dbh->{RaiseError} = 1;
1729 local $dbh->{PrintError} = 0;
1731 $sth->execute foreach 1..$count;
1737 # Make sure statement is finished even if there was an exception.
1742 $err = shift unless defined $err;
1746 $self->throw_exception($err) if defined $err;
1752 my ($self, $source, @args) = @_;
1754 my $bind_attrs = $self->source_bind_attributes($source);
1756 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1761 my ($self, $source, @args) = @_;
1763 my $bind_attrs = $self->source_bind_attributes($source);
1765 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1768 # We were sent here because the $rs contains a complex search
1769 # which will require a subquery to select the correct rows
1770 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1772 # Generating a single PK column subquery is trivial and supported
1773 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1774 # Look at _multipk_update_delete()
1775 sub _subq_update_delete {
1777 my ($rs, $op, $values) = @_;
1779 my $rsrc = $rs->result_source;
1781 # quick check if we got a sane rs on our hands
1782 my @pcols = $rsrc->_pri_cols;
1784 my $sel = $rs->_resolved_attrs->{select};
1785 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1788 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1790 join ("\x00", sort @$sel )
1792 $self->throw_exception (
1793 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1800 $op eq 'update' ? $values : (),
1801 { $pcols[0] => { -in => $rs->as_query } },
1806 return $self->_multipk_update_delete (@_);
1810 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1811 # resultset update/delete involving subqueries. So by default resort
1812 # to simple (and inefficient) delete_all style per-row opearations,
1813 # while allowing specific storages to override this with a faster
1816 sub _multipk_update_delete {
1817 return shift->_per_row_update_delete (@_);
1820 # This is the default loop used to delete/update rows for multi PK
1821 # resultsets, and used by mysql exclusively (because it can't do anything
1824 # We do not use $row->$op style queries, because resultset update/delete
1825 # is not expected to cascade (this is what delete_all/update_all is for).
1827 # There should be no race conditions as the entire operation is rolled
1830 sub _per_row_update_delete {
1832 my ($rs, $op, $values) = @_;
1834 my $rsrc = $rs->result_source;
1835 my @pcols = $rsrc->_pri_cols;
1837 my $guard = $self->txn_scope_guard;
1839 # emulate the return value of $sth->execute for non-selects
1840 my $row_cnt = '0E0';
1842 my $subrs_cur = $rs->cursor;
1843 my @all_pk = $subrs_cur->all;
1844 for my $pks ( @all_pk) {
1847 for my $i (0.. $#pcols) {
1848 $cond->{$pcols[$i]} = $pks->[$i];
1853 $op eq 'update' ? $values : (),
1867 $self->_execute($self->_select_args(@_));
1870 sub _select_args_to_query {
1873 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $rs_attrs, $rows, $offset)
1874 # = $self->_select_args($ident, $select, $cond, $attrs);
1875 my ($op, $bind, $ident, $bind_attrs, @args) =
1876 $self->_select_args(@_);
1878 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
1879 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1880 $prepared_bind ||= [];
1883 ? ($sql, $prepared_bind, $bind_attrs)
1884 : \[ "($sql)", @$prepared_bind ]
1889 my ($self, $ident, $select, $where, $attrs) = @_;
1891 my $sql_maker = $self->sql_maker;
1892 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1899 $rs_alias && $alias2source->{$rs_alias}
1900 ? ( _rsroot_source_handle => $alias2source->{$rs_alias}->handle )
1905 # calculate bind_attrs before possible $ident mangling
1906 my $bind_attrs = {};
1907 for my $alias (keys %$alias2source) {
1908 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1909 for my $col (keys %$bindtypes) {
1911 my $fqcn = join ('.', $alias, $col);
1912 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1914 # Unqialified column names are nice, but at the same time can be
1915 # rather ambiguous. What we do here is basically go along with
1916 # the loop, adding an unqualified column slot to $bind_attrs,
1917 # alongside the fully qualified name. As soon as we encounter
1918 # another column by that name (which would imply another table)
1919 # we unset the unqualified slot and never add any info to it
1920 # to avoid erroneous type binding. If this happens the users
1921 # only choice will be to fully qualify his column name
1923 if (exists $bind_attrs->{$col}) {
1924 $bind_attrs->{$col} = {};
1927 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1933 if (defined $attrs->{rows}) {
1934 $self->throw_exception("rows attribute must be positive if present")
1935 unless $attrs->{rows} > 0;
1937 elsif (defined $attrs->{offset}) {
1938 # MySQL actually recommends this approach. I cringe.
1939 $attrs->{rows} = 2**32;
1944 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1945 # storage, unless software limit was requested
1948 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1950 # grouped prefetch (to satisfy group_by == select)
1951 ( $attrs->{group_by}
1953 @{$attrs->{group_by}}
1955 $attrs->{_prefetch_select}
1957 @{$attrs->{_prefetch_select}}
1960 ($ident, $select, $where, $attrs)
1961 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1963 elsif (! $attrs->{software_limit} ) {
1964 push @limit, $attrs->{rows}, $attrs->{offset};
1967 # try to simplify the joinmap further (prune unreferenced type-single joins)
1968 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1971 # This would be the point to deflate anything found in $where
1972 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1973 # expect a row object. And all we have is a resultsource (it is trivial
1974 # to extract deflator coderefs via $alias2source above).
1976 # I don't see a way forward other than changing the way deflators are
1977 # invoked, and that's just bad...
1980 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $attrs, @limit);
1983 # Returns a counting SELECT for a simple count
1984 # query. Abstracted so that a storage could override
1985 # this to { count => 'firstcol' } or whatever makes
1986 # sense as a performance optimization
1988 #my ($self, $source, $rs_attrs) = @_;
1989 return { count => '*' };
1993 sub source_bind_attributes {
1994 my ($self, $source) = @_;
1996 my $bind_attributes;
1997 foreach my $column ($source->columns) {
1999 my $data_type = $source->column_info($column)->{data_type} || '';
2000 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
2004 return $bind_attributes;
2011 =item Arguments: $ident, $select, $condition, $attrs
2015 Handle a SQL select statement.
2021 my ($ident, $select, $condition, $attrs) = @_;
2022 return $self->cursor_class->new($self, \@_, $attrs);
2027 my ($rv, $sth, @bind) = $self->_select(@_);
2028 my @row = $sth->fetchrow_array;
2029 my @nextrow = $sth->fetchrow_array if @row;
2030 if(@row && @nextrow) {
2031 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2033 # Need to call finish() to work round broken DBDs
2042 =item Arguments: $sql
2046 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2051 my ($self, $dbh, $sql) = @_;
2053 # 3 is the if_active parameter which avoids active sth re-use
2054 my $sth = $self->disable_sth_caching
2055 ? $dbh->prepare($sql)
2056 : $dbh->prepare_cached($sql, {}, 3);
2058 # XXX You would think RaiseError would make this impossible,
2059 # but apparently that's not true :(
2060 $self->throw_exception($dbh->errstr) if !$sth;
2066 my ($self, $sql) = @_;
2067 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2070 sub _dbh_columns_info_for {
2071 my ($self, $dbh, $table) = @_;
2073 if ($dbh->can('column_info')) {
2077 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2078 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2080 while ( my $info = $sth->fetchrow_hashref() ){
2082 $column_info{data_type} = $info->{TYPE_NAME};
2083 $column_info{size} = $info->{COLUMN_SIZE};
2084 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2085 $column_info{default_value} = $info->{COLUMN_DEF};
2086 my $col_name = $info->{COLUMN_NAME};
2087 $col_name =~ s/^\"(.*)\"$/$1/;
2089 $result{$col_name} = \%column_info;
2094 return \%result if !$caught && scalar keys %result;
2098 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2100 my @columns = @{$sth->{NAME_lc}};
2101 for my $i ( 0 .. $#columns ){
2103 $column_info{data_type} = $sth->{TYPE}->[$i];
2104 $column_info{size} = $sth->{PRECISION}->[$i];
2105 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2107 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2108 $column_info{data_type} = $1;
2109 $column_info{size} = $2;
2112 $result{$columns[$i]} = \%column_info;
2116 foreach my $col (keys %result) {
2117 my $colinfo = $result{$col};
2118 my $type_num = $colinfo->{data_type};
2120 if(defined $type_num && $dbh->can('type_info')) {
2121 my $type_info = $dbh->type_info($type_num);
2122 $type_name = $type_info->{TYPE_NAME} if $type_info;
2123 $colinfo->{data_type} = $type_name if $type_name;
2130 sub columns_info_for {
2131 my ($self, $table) = @_;
2132 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2135 =head2 last_insert_id
2137 Return the row id of the last insert.
2141 sub _dbh_last_insert_id {
2142 my ($self, $dbh, $source, $col) = @_;
2144 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2146 return $id if defined $id;
2148 my $class = ref $self;
2149 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2152 sub last_insert_id {
2154 $self->_dbh_last_insert_id ($self->_dbh, @_);
2157 =head2 _native_data_type
2161 =item Arguments: $type_name
2165 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2166 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2167 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2169 The default implementation returns C<undef>, implement in your Storage driver if
2170 you need this functionality.
2172 Should map types from other databases to the native RDBMS type, for example
2173 C<VARCHAR2> to C<VARCHAR>.
2175 Types with modifiers should map to the underlying data type. For example,
2176 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2178 Composite types should map to the container type, for example
2179 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2183 sub _native_data_type {
2184 #my ($self, $data_type) = @_;
2188 # Check if placeholders are supported at all
2189 sub _placeholders_supported {
2191 my $dbh = $self->_get_dbh;
2193 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2194 # but it is inaccurate more often than not
2196 local $dbh->{PrintError} = 0;
2197 local $dbh->{RaiseError} = 1;
2198 $dbh->do('select ?', {}, 1);
2206 # Check if placeholders bound to non-string types throw exceptions
2208 sub _typeless_placeholders_supported {
2210 my $dbh = $self->_get_dbh;
2213 local $dbh->{PrintError} = 0;
2214 local $dbh->{RaiseError} = 1;
2215 # this specifically tests a bind that is NOT a string
2216 $dbh->do('select 1 where 1 = ?', {}, 1);
2226 Returns the database driver name.
2231 shift->_get_dbh->{Driver}->{Name};
2234 =head2 bind_attribute_by_data_type
2236 Given a datatype from column info, returns a database specific bind
2237 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2238 let the database planner just handle it.
2240 Generally only needed for special case column types, like bytea in postgres.
2244 sub bind_attribute_by_data_type {
2248 =head2 is_datatype_numeric
2250 Given a datatype from column_info, returns a boolean value indicating if
2251 the current RDBMS considers it a numeric value. This controls how
2252 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2253 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2254 be performed instead of the usual C<eq>.
2258 sub is_datatype_numeric {
2259 my ($self, $dt) = @_;
2261 return 0 unless $dt;
2263 return $dt =~ /^ (?:
2264 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2269 =head2 create_ddl_dir
2273 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2277 Creates a SQL file based on the Schema, for each of the specified
2278 database engines in C<\@databases> in the given directory.
2279 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2281 Given a previous version number, this will also create a file containing
2282 the ALTER TABLE statements to transform the previous schema into the
2283 current one. Note that these statements may contain C<DROP TABLE> or
2284 C<DROP COLUMN> statements that can potentially destroy data.
2286 The file names are created using the C<ddl_filename> method below, please
2287 override this method in your schema if you would like a different file
2288 name format. For the ALTER file, the same format is used, replacing
2289 $version in the name with "$preversion-$version".
2291 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2292 The most common value for this would be C<< { add_drop_table => 1 } >>
2293 to have the SQL produced include a C<DROP TABLE> statement for each table
2294 created. For quoting purposes supply C<quote_table_names> and
2295 C<quote_field_names>.
2297 If no arguments are passed, then the following default values are assumed:
2301 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2303 =item version - $schema->schema_version
2305 =item directory - './'
2307 =item preversion - <none>
2311 By default, C<\%sqlt_args> will have
2313 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2315 merged with the hash passed in. To disable any of those features, pass in a
2316 hashref like the following
2318 { ignore_constraint_names => 0, # ... other options }
2321 WARNING: You are strongly advised to check all SQL files created, before applying
2326 sub create_ddl_dir {
2327 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2330 carp "No directory given, using ./\n";
2333 -d $dir or File::Path::mkpath($dir)
2334 or $self->throw_exception("create_ddl_dir: $! creating dir '$dir'");
2337 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2339 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2340 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2342 my $schema_version = $schema->schema_version || '1.x';
2343 $version ||= $schema_version;
2346 add_drop_table => 1,
2347 ignore_constraint_names => 1,
2348 ignore_index_names => 1,
2352 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2353 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2356 my $sqlt = SQL::Translator->new( $sqltargs );
2358 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2359 my $sqlt_schema = $sqlt->translate({ data => $schema })
2360 or $self->throw_exception ($sqlt->error);
2362 foreach my $db (@$databases) {
2364 $sqlt->{schema} = $sqlt_schema;
2365 $sqlt->producer($db);
2368 my $filename = $schema->ddl_filename($db, $version, $dir);
2369 if (-e $filename && ($version eq $schema_version )) {
2370 # if we are dumping the current version, overwrite the DDL
2371 carp "Overwriting existing DDL file - $filename";
2375 my $output = $sqlt->translate;
2377 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2380 if(!open($file, ">$filename")) {
2381 $self->throw_exception("Can't open $filename for writing ($!)");
2384 print $file $output;
2387 next unless ($preversion);
2389 require SQL::Translator::Diff;
2391 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2392 if(!-e $prefilename) {
2393 carp("No previous schema file found ($prefilename)");
2397 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2399 carp("Overwriting existing diff file - $difffile");
2405 my $t = SQL::Translator->new($sqltargs);
2410 or $self->throw_exception ($t->error);
2412 my $out = $t->translate( $prefilename )
2413 or $self->throw_exception ($t->error);
2415 $source_schema = $t->schema;
2417 $source_schema->name( $prefilename )
2418 unless ( $source_schema->name );
2421 # The "new" style of producers have sane normalization and can support
2422 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2423 # And we have to diff parsed SQL against parsed SQL.
2424 my $dest_schema = $sqlt_schema;
2426 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2427 my $t = SQL::Translator->new($sqltargs);
2432 or $self->throw_exception ($t->error);
2434 my $out = $t->translate( $filename )
2435 or $self->throw_exception ($t->error);
2437 $dest_schema = $t->schema;
2439 $dest_schema->name( $filename )
2440 unless $dest_schema->name;
2443 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2447 if(!open $file, ">$difffile") {
2448 $self->throw_exception("Can't write to $difffile ($!)");
2456 =head2 deployment_statements
2460 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2464 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2466 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2467 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2469 C<$directory> is used to return statements from files in a previously created
2470 L</create_ddl_dir> directory and is optional. The filenames are constructed
2471 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2473 If no C<$directory> is specified then the statements are constructed on the
2474 fly using L<SQL::Translator> and C<$version> is ignored.
2476 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2480 sub deployment_statements {
2481 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2482 $type ||= $self->sqlt_type;
2483 $version ||= $schema->schema_version || '1.x';
2485 my $filename = $schema->ddl_filename($type, $version, $dir);
2489 open($file, "<$filename")
2490 or $self->throw_exception("Can't open $filename ($!)");
2493 return join('', @rows);
2496 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2497 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2500 # sources needs to be a parser arg, but for simplicty allow at top level
2502 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2503 if exists $sqltargs->{sources};
2505 my $tr = SQL::Translator->new(
2506 producer => "SQL::Translator::Producer::${type}",
2508 parser => 'SQL::Translator::Parser::DBIx::Class',
2515 @ret = $tr->translate;
2518 $ret[0] = $tr->translate;
2521 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2522 unless (@ret && defined $ret[0]);
2524 return $wa ? @ret : $ret[0];
2528 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2531 return if($line =~ /^--/);
2533 # next if($line =~ /^DROP/m);
2534 return if($line =~ /^BEGIN TRANSACTION/m);
2535 return if($line =~ /^COMMIT/m);
2536 return if $line =~ /^\s+$/; # skip whitespace only
2537 $self->_query_start($line);
2539 # do a dbh_do cycle here, as we need some error checking in
2540 # place (even though we will ignore errors)
2541 $self->dbh_do (sub { $_[1]->do($line) });
2543 carp qq{$_ (running "${line}")};
2545 $self->_query_end($line);
2547 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2548 if (@statements > 1) {
2549 foreach my $statement (@statements) {
2550 $deploy->( $statement );
2553 elsif (@statements == 1) {
2554 foreach my $line ( split(";\n", $statements[0])) {
2560 =head2 datetime_parser
2562 Returns the datetime parser class
2566 sub datetime_parser {
2568 return $self->{datetime_parser} ||= do {
2569 $self->build_datetime_parser(@_);
2573 =head2 datetime_parser_type
2575 Defines (returns) the datetime parser class - currently hardwired to
2576 L<DateTime::Format::MySQL>
2580 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2582 =head2 build_datetime_parser
2584 See L</datetime_parser>
2588 sub build_datetime_parser {
2590 my $type = $self->datetime_parser_type(@_);
2591 $self->ensure_class_loaded ($type);
2596 =head2 is_replicating
2598 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2599 replicate from a master database. Default is undef, which is the result
2600 returned by databases that don't support replication.
2604 sub is_replicating {
2609 =head2 lag_behind_master
2611 Returns a number that represents a certain amount of lag behind a master db
2612 when a given storage is replicating. The number is database dependent, but
2613 starts at zero and increases with the amount of lag. Default in undef
2617 sub lag_behind_master {
2621 =head2 relname_to_table_alias
2625 =item Arguments: $relname, $join_count
2629 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2632 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2633 way these aliases are named.
2635 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2636 otherwise C<"$relname">.
2640 sub relname_to_table_alias {
2641 my ($self, $relname, $join_count) = @_;
2643 my $alias = ($join_count && $join_count > 1 ?
2644 join('_', $relname, $join_count) : $relname);
2653 =head2 DBIx::Class and AutoCommit
2655 DBIx::Class can do some wonderful magic with handling exceptions,
2656 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2657 (the default) combined with C<txn_do> for transaction support.
2659 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2660 in an assumed transaction between commits, and you're telling us you'd
2661 like to manage that manually. A lot of the magic protections offered by
2662 this module will go away. We can't protect you from exceptions due to database
2663 disconnects because we don't know anything about how to restart your
2664 transactions. You're on your own for handling all sorts of exceptional
2665 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2671 Matt S. Trout <mst@shadowcatsystems.co.uk>
2673 Andy Grundman <andy@hybridized.org>
2677 You may distribute this code under the same terms as Perl itself.