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();
21 __PACKAGE__->mk_group_accessors('simple' =>
22 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
23 _conn_tid transaction_depth _dbh_autocommit _driver_determined 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"} = Sub::Name::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) {
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 : ()]);
585 return $self->_connect_info;
588 sub _normalize_connect_info {
589 my ($self, $info_arg) = @_;
592 my @args = @$info_arg; # take a shallow copy for further mutilation
594 # combine/pre-parse arguments depending on invocation style
597 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
598 %attrs = %{ $args[1] || {} };
601 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
602 %attrs = %{$args[0]};
604 if (my $code = delete $attrs{dbh_maker}) {
607 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
610 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
611 . "to the result of 'dbh_maker'",
613 join (', ', map { "'$_'" } (@ignored) ),
618 @args = delete @attrs{qw/dsn user password/};
621 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
623 % { $args[3] || {} },
624 % { $args[4] || {} },
626 @args = @args[0,1,2];
629 $info{arguments} = \@args;
631 my @storage_opts = grep exists $attrs{$_},
632 @storage_options, 'cursor_class';
634 @{ $info{storage_options} }{@storage_opts} =
635 delete @attrs{@storage_opts} if @storage_opts;
637 my @sql_maker_opts = grep exists $attrs{$_},
638 qw/limit_dialect quote_char name_sep/;
640 @{ $info{sql_maker_options} }{@sql_maker_opts} =
641 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
643 $info{attributes} = \%attrs if %attrs;
648 sub _default_dbi_connect_attributes {
658 This method is deprecated in favour of setting via L</connect_info>.
662 =head2 on_disconnect_do
664 This method is deprecated in favour of setting via L</connect_info>.
668 sub _parse_connect_do {
669 my ($self, $type) = @_;
671 my $val = $self->$type;
672 return () if not defined $val;
677 push @res, [ 'do_sql', $val ];
678 } elsif (ref($val) eq 'CODE') {
680 } elsif (ref($val) eq 'ARRAY') {
681 push @res, map { [ 'do_sql', $_ ] } @$val;
683 $self->throw_exception("Invalid type for $type: ".ref($val));
691 Arguments: ($subref | $method_name), @extra_coderef_args?
693 Execute the given $subref or $method_name using the new exception-based
694 connection management.
696 The first two arguments will be the storage object that C<dbh_do> was called
697 on and a database handle to use. Any additional arguments will be passed
698 verbatim to the called subref as arguments 2 and onwards.
700 Using this (instead of $self->_dbh or $self->dbh) ensures correct
701 exception handling and reconnection (or failover in future subclasses).
703 Your subref should have no side-effects outside of the database, as
704 there is the potential for your subref to be partially double-executed
705 if the database connection was stale/dysfunctional.
709 my @stuff = $schema->storage->dbh_do(
711 my ($storage, $dbh, @cols) = @_;
712 my $cols = join(q{, }, @cols);
713 $dbh->selectrow_array("SELECT $cols FROM foo");
724 my $dbh = $self->_get_dbh;
726 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
727 || $self->{transaction_depth};
729 local $self->{_in_dbh_do} = 1;
732 my $want_array = wantarray;
737 @result = $self->$code($dbh, @_);
739 elsif(defined $want_array) {
740 $result[0] = $self->$code($dbh, @_);
743 $self->$code($dbh, @_);
747 # ->connected might unset $@ - copy
749 if(!$exception) { return $want_array ? @result : $result[0] }
751 $self->throw_exception($exception) if $self->connected;
753 # We were not connected - reconnect and retry, but let any
754 # exception fall right through this time
755 carp "Retrying $code after catching disconnected exception: $exception"
756 if $ENV{DBIC_DBIRETRY_DEBUG};
757 $self->_populate_dbh;
758 $self->$code($self->_dbh, @_);
761 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
762 # It also informs dbh_do to bypass itself while under the direction of txn_do,
763 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
768 ref $coderef eq 'CODE' or $self->throw_exception
769 ('$coderef must be a CODE reference');
771 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
773 local $self->{_in_dbh_do} = 1;
776 my $want_array = wantarray;
785 @result = $coderef->(@_);
787 elsif(defined $want_array) {
788 $result[0] = $coderef->(@_);
796 # ->connected might unset $@ - copy
798 if(!$exception) { return $want_array ? @result : $result[0] }
800 if($tried++ || $self->connected) {
801 eval { $self->txn_rollback };
802 my $rollback_exception = $@;
803 if($rollback_exception) {
804 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
805 $self->throw_exception($exception) # propagate nested rollback
806 if $rollback_exception =~ /$exception_class/;
808 $self->throw_exception(
809 "Transaction aborted: ${exception}. "
810 . "Rollback failed: ${rollback_exception}"
813 $self->throw_exception($exception)
816 # We were not connected, and was first try - reconnect and retry
818 carp "Retrying $coderef after catching disconnected exception: $exception"
819 if $ENV{DBIC_DBIRETRY_DEBUG};
820 $self->_populate_dbh;
826 Our C<disconnect> method also performs a rollback first if the
827 database is not in C<AutoCommit> mode.
837 push @actions, ( $self->on_disconnect_call || () );
838 push @actions, $self->_parse_connect_do ('on_disconnect_do');
840 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
842 $self->_dbh_rollback unless $self->_dbh_autocommit;
844 %{ $self->_dbh->{CachedKids} } = ();
845 $self->_dbh->disconnect;
851 =head2 with_deferred_fk_checks
855 =item Arguments: C<$coderef>
857 =item Return Value: The return value of $coderef
861 Storage specific method to run the code ref with FK checks deferred or
862 in MySQL's case disabled entirely.
866 # Storage subclasses should override this
867 sub with_deferred_fk_checks {
868 my ($self, $sub) = @_;
876 =item Arguments: none
878 =item Return Value: 1|0
882 Verifies that the current database handle is active and ready to execute
883 an SQL statement (e.g. the connection did not get stale, server is still
884 answering, etc.) This method is used internally by L</dbh>.
890 return 0 unless $self->_seems_connected;
893 local $self->_dbh->{RaiseError} = 1;
898 sub _seems_connected {
901 $self->_preserve_foreign_dbh;
903 my $dbh = $self->_dbh
906 return $dbh->FETCH('Active');
912 my $dbh = $self->_dbh or return 0;
917 sub ensure_connected {
920 unless ($self->connected) {
921 $self->_populate_dbh;
927 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
928 is guaranteed to be healthy by implicitly calling L</connected>, and if
929 necessary performing a reconnection before returning. Keep in mind that this
930 is very B<expensive> on some database engines. Consider using L</dbh_do>
938 if (not $self->_dbh) {
939 $self->_populate_dbh;
941 $self->ensure_connected;
946 # this is the internal "get dbh or connect (don't check)" method
949 $self->_preserve_foreign_dbh;
950 $self->_populate_dbh unless $self->_dbh;
954 sub _sql_maker_args {
959 array_datatypes => 1,
960 limit_dialect => $self->_get_dbh,
961 %{$self->_sql_maker_opts}
967 unless ($self->_sql_maker) {
968 my $sql_maker_class = $self->sql_maker_class;
969 $self->ensure_class_loaded ($sql_maker_class);
970 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
972 return $self->_sql_maker;
975 # nothing to do by default
982 my @info = @{$self->_dbi_connect_info || []};
983 $self->_dbh(undef); # in case ->connected failed we might get sent here
984 $self->_server_info_hash (undef);
985 $self->_dbh($self->_connect(@info));
987 $self->_conn_pid($$);
988 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
990 $self->_determine_driver;
992 # Always set the transaction depth on connect, since
993 # there is no transaction in progress by definition
994 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
996 $self->_run_connection_actions unless $self->{_in_determine_driver};
999 sub _run_connection_actions {
1003 push @actions, ( $self->on_connect_call || () );
1004 push @actions, $self->_parse_connect_do ('on_connect_do');
1006 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1012 unless ($self->_server_info_hash) {
1016 my $server_version = do {
1017 local $@; # might be happenin in some sort of destructor
1018 eval { $self->_get_server_version };
1021 if (defined $server_version) {
1022 $info{dbms_version} = $server_version;
1024 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1025 my @verparts = split (/\./, $numeric_version);
1031 # consider only up to 3 version parts, iff not more than 3 digits
1033 while (@verparts && @use_parts < 3) {
1034 my $p = shift @verparts;
1036 push @use_parts, $p;
1038 push @use_parts, 0 while @use_parts < 3;
1040 $info{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1044 $self->_server_info_hash(\%info);
1047 return $self->_server_info_hash
1050 sub _get_server_version {
1051 shift->_get_dbh->get_info(18);
1054 sub _determine_driver {
1057 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1058 my $started_connected = 0;
1059 local $self->{_in_determine_driver} = 1;
1061 if (ref($self) eq __PACKAGE__) {
1063 if ($self->_dbh) { # we are connected
1064 $driver = $self->_dbh->{Driver}{Name};
1065 $started_connected = 1;
1067 # if connect_info is a CODEREF, we have no choice but to connect
1068 if (ref $self->_dbi_connect_info->[0] &&
1069 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
1070 $self->_populate_dbh;
1071 $driver = $self->_dbh->{Driver}{Name};
1074 # try to use dsn to not require being connected, the driver may still
1075 # force a connection in _rebless to determine version
1076 # (dsn may not be supplied at all if all we do is make a mock-schema)
1077 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1078 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1079 $driver ||= $ENV{DBI_DRIVER};
1084 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1085 if ($self->load_optional_class($storage_class)) {
1086 mro::set_mro($storage_class, 'c3');
1087 bless $self, $storage_class;
1093 $self->_driver_determined(1);
1095 $self->_init; # run driver-specific initializations
1097 $self->_run_connection_actions
1098 if !$started_connected && defined $self->_dbh;
1102 sub _do_connection_actions {
1104 my $method_prefix = shift;
1107 if (not ref($call)) {
1108 my $method = $method_prefix . $call;
1110 } elsif (ref($call) eq 'CODE') {
1112 } elsif (ref($call) eq 'ARRAY') {
1113 if (ref($call->[0]) ne 'ARRAY') {
1114 $self->_do_connection_actions($method_prefix, $_) for @$call;
1116 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1119 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1125 sub connect_call_do_sql {
1127 $self->_do_query(@_);
1130 sub disconnect_call_do_sql {
1132 $self->_do_query(@_);
1135 # override in db-specific backend when necessary
1136 sub connect_call_datetime_setup { 1 }
1139 my ($self, $action) = @_;
1141 if (ref $action eq 'CODE') {
1142 $action = $action->($self);
1143 $self->_do_query($_) foreach @$action;
1146 # Most debuggers expect ($sql, @bind), so we need to exclude
1147 # the attribute hash which is the second argument to $dbh->do
1148 # furthermore the bind values are usually to be presented
1149 # as named arrayref pairs, so wrap those here too
1150 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1151 my $sql = shift @do_args;
1152 my $attrs = shift @do_args;
1153 my @bind = map { [ undef, $_ ] } @do_args;
1155 $self->_query_start($sql, @bind);
1156 $self->_get_dbh->do($sql, $attrs, @do_args);
1157 $self->_query_end($sql, @bind);
1164 my ($self, @info) = @_;
1166 $self->throw_exception("You failed to provide any connection info")
1169 my ($old_connect_via, $dbh);
1171 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1172 $old_connect_via = $DBI::connect_via;
1173 $DBI::connect_via = 'connect';
1177 if(ref $info[0] eq 'CODE') {
1178 $dbh = $info[0]->();
1181 $dbh = DBI->connect(@info);
1184 if($dbh && !$self->unsafe) {
1185 my $weak_self = $self;
1186 Scalar::Util::weaken($weak_self);
1187 $dbh->{HandleError} = sub {
1189 $weak_self->throw_exception("DBI Exception: $_[0]");
1192 # the handler may be invoked by something totally out of
1194 croak ("DBI Exception: $_[0]");
1197 $dbh->{ShowErrorStatement} = 1;
1198 $dbh->{RaiseError} = 1;
1199 $dbh->{PrintError} = 0;
1203 $DBI::connect_via = $old_connect_via if $old_connect_via;
1205 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1208 $self->_dbh_autocommit($dbh->{AutoCommit});
1214 my ($self, $name) = @_;
1216 $name = $self->_svp_generate_name
1217 unless defined $name;
1219 $self->throw_exception ("You can't use savepoints outside a transaction")
1220 if $self->{transaction_depth} == 0;
1222 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1223 unless $self->can('_svp_begin');
1225 push @{ $self->{savepoints} }, $name;
1227 $self->debugobj->svp_begin($name) if $self->debug;
1229 return $self->_svp_begin($name);
1233 my ($self, $name) = @_;
1235 $self->throw_exception ("You can't use savepoints outside a transaction")
1236 if $self->{transaction_depth} == 0;
1238 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1239 unless $self->can('_svp_release');
1241 if (defined $name) {
1242 $self->throw_exception ("Savepoint '$name' does not exist")
1243 unless grep { $_ eq $name } @{ $self->{savepoints} };
1245 # Dig through the stack until we find the one we are releasing. This keeps
1246 # the stack up to date.
1249 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1251 $name = pop @{ $self->{savepoints} };
1254 $self->debugobj->svp_release($name) if $self->debug;
1256 return $self->_svp_release($name);
1260 my ($self, $name) = @_;
1262 $self->throw_exception ("You can't use savepoints outside a transaction")
1263 if $self->{transaction_depth} == 0;
1265 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1266 unless $self->can('_svp_rollback');
1268 if (defined $name) {
1269 # If they passed us a name, verify that it exists in the stack
1270 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1271 $self->throw_exception("Savepoint '$name' does not exist!");
1274 # Dig through the stack until we find the one we are releasing. This keeps
1275 # the stack up to date.
1276 while(my $s = pop(@{ $self->{savepoints} })) {
1277 last if($s eq $name);
1279 # Add the savepoint back to the stack, as a rollback doesn't remove the
1280 # named savepoint, only everything after it.
1281 push(@{ $self->{savepoints} }, $name);
1283 # We'll assume they want to rollback to the last savepoint
1284 $name = $self->{savepoints}->[-1];
1287 $self->debugobj->svp_rollback($name) if $self->debug;
1289 return $self->_svp_rollback($name);
1292 sub _svp_generate_name {
1295 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1301 # this means we have not yet connected and do not know the AC status
1302 # (e.g. coderef $dbh)
1303 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1305 if($self->{transaction_depth} == 0) {
1306 $self->debugobj->txn_begin()
1308 $self->_dbh_begin_work;
1310 elsif ($self->auto_savepoint) {
1313 $self->{transaction_depth}++;
1316 sub _dbh_begin_work {
1319 # if the user is utilizing txn_do - good for him, otherwise we need to
1320 # ensure that the $dbh is healthy on BEGIN.
1321 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1322 # will be replaced by a failure of begin_work itself (which will be
1323 # then retried on reconnect)
1324 if ($self->{_in_dbh_do}) {
1325 $self->_dbh->begin_work;
1327 $self->dbh_do(sub { $_[1]->begin_work });
1333 if ($self->{transaction_depth} == 1) {
1334 $self->debugobj->txn_commit()
1337 $self->{transaction_depth} = 0
1338 if $self->_dbh_autocommit;
1340 elsif($self->{transaction_depth} > 1) {
1341 $self->{transaction_depth}--;
1343 if $self->auto_savepoint;
1349 my $dbh = $self->_dbh
1350 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1356 my $dbh = $self->_dbh;
1358 if ($self->{transaction_depth} == 1) {
1359 $self->debugobj->txn_rollback()
1361 $self->{transaction_depth} = 0
1362 if $self->_dbh_autocommit;
1363 $self->_dbh_rollback;
1365 elsif($self->{transaction_depth} > 1) {
1366 $self->{transaction_depth}--;
1367 if ($self->auto_savepoint) {
1368 $self->svp_rollback;
1373 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1378 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1379 $error =~ /$exception_class/ and $self->throw_exception($error);
1380 # ensure that a failed rollback resets the transaction depth
1381 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1382 $self->throw_exception($error);
1388 my $dbh = $self->_dbh
1389 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1393 # This used to be the top-half of _execute. It was split out to make it
1394 # easier to override in NoBindVars without duping the rest. It takes up
1395 # all of _execute's args, and emits $sql, @bind.
1396 sub _prep_for_execute {
1397 my ($self, $op, $extra_bind, $ident, $args) = @_;
1399 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1400 $ident = $ident->from();
1403 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1406 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1408 return ($sql, \@bind);
1412 sub _fix_bind_params {
1413 my ($self, @bind) = @_;
1415 ### Turn @bind from something like this:
1416 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1418 ### ( "'1'", "'1'", "'3'" )
1421 if ( defined( $_ && $_->[1] ) ) {
1422 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1429 my ( $self, $sql, @bind ) = @_;
1431 if ( $self->debug ) {
1432 @bind = $self->_fix_bind_params(@bind);
1434 $self->debugobj->query_start( $sql, @bind );
1439 my ( $self, $sql, @bind ) = @_;
1441 if ( $self->debug ) {
1442 @bind = $self->_fix_bind_params(@bind);
1443 $self->debugobj->query_end( $sql, @bind );
1448 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1450 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1452 $self->_query_start( $sql, @$bind );
1454 my $sth = $self->sth($sql,$op);
1456 my $placeholder_index = 1;
1458 foreach my $bound (@$bind) {
1459 my $attributes = {};
1460 my($column_name, @data) = @$bound;
1462 if ($bind_attributes) {
1463 $attributes = $bind_attributes->{$column_name}
1464 if defined $bind_attributes->{$column_name};
1467 foreach my $data (@data) {
1468 my $ref = ref $data;
1469 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1471 $sth->bind_param($placeholder_index, $data, $attributes);
1472 $placeholder_index++;
1476 # Can this fail without throwing an exception anyways???
1477 my $rv = $sth->execute();
1478 $self->throw_exception($sth->errstr) if !$rv;
1480 $self->_query_end( $sql, @$bind );
1482 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1487 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1490 sub _prefetch_insert_auto_nextvals {
1491 my ($self, $source, $to_insert) = @_;
1495 foreach my $col ( $source->columns ) {
1496 if ( !defined $to_insert->{$col} ) {
1497 my $col_info = $source->column_info($col);
1499 if ( $col_info->{auto_nextval} ) {
1500 $upd->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1502 $col_info->{sequence} ||=
1503 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1514 my ($source, $to_insert, $opts) = @_;
1516 my $updated_cols = $self->_prefetch_insert_auto_nextvals (@_);
1518 my $bind_attributes = $self->source_bind_attributes($source);
1520 my ($rv, $sth) = $self->_execute('insert' => [], $source, $bind_attributes, $to_insert, $opts);
1522 if ($opts->{returning}) {
1523 my @ret_cols = @{$opts->{returning}};
1525 my @ret_vals = eval {
1526 local $SIG{__WARN__} = sub {};
1527 my @r = $sth->fetchrow_array;
1533 @ret{@ret_cols} = @ret_vals if (@ret_vals);
1541 return $updated_cols;
1544 ## Currently it is assumed that all values passed will be "normal", i.e. not
1545 ## scalar refs, or at least, all the same type as the first set, the statement is
1546 ## only prepped once.
1548 my ($self, $source, $cols, $data) = @_;
1551 @colvalues{@$cols} = (0..$#$cols);
1553 for my $i (0..$#$cols) {
1554 my $first_val = $data->[0][$i];
1555 next unless ref $first_val eq 'SCALAR';
1557 $colvalues{ $cols->[$i] } = $first_val;
1560 # check for bad data and stringify stringifiable objects
1561 my $bad_slice = sub {
1562 my ($msg, $col_idx, $slice_idx) = @_;
1563 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1567 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1568 Data::Dumper::Concise::Dumper({
1569 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1575 for my $datum_idx (0..$#$data) {
1576 my $datum = $data->[$datum_idx];
1578 for my $col_idx (0..$#$cols) {
1579 my $val = $datum->[$col_idx];
1580 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1581 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1583 if ($is_literal_sql) {
1585 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1587 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1588 $bad_slice->("$reftype reference found where literal SQL expected",
1589 $col_idx, $datum_idx);
1591 elsif ($$val ne $$sqla_bind){
1592 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1593 $col_idx, $datum_idx);
1596 elsif (my $reftype = ref $val) {
1598 if (overload::Method($val, '""')) {
1599 $datum->[$col_idx] = "".$val;
1602 $bad_slice->("$reftype reference found where bind expected",
1603 $col_idx, $datum_idx);
1609 my ($sql, $bind) = $self->_prep_for_execute (
1610 'insert', undef, $source, [\%colvalues]
1614 my $empty_bind = 1 if (not @bind) &&
1615 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1617 if ((not @bind) && (not $empty_bind)) {
1618 $self->throw_exception(
1619 'Cannot insert_bulk without support for placeholders'
1623 # neither _execute_array, nor _execute_inserts_with_no_binds are
1624 # atomic (even if _execute _array is a single call). Thus a safety
1626 my $guard = $self->txn_scope_guard;
1628 $self->_query_start( $sql, ['__BULK__'] );
1629 my $sth = $self->sth($sql);
1632 # bind_param_array doesn't work if there are no binds
1633 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1636 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1637 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1641 $self->_query_end( $sql, ['__BULK__'] );
1645 return (wantarray ? ($rv, $sth, @bind) : $rv);
1648 sub _execute_array {
1649 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1651 ## This must be an arrayref, else nothing works!
1652 my $tuple_status = [];
1654 ## Get the bind_attributes, if any exist
1655 my $bind_attributes = $self->source_bind_attributes($source);
1657 ## Bind the values and execute
1658 my $placeholder_index = 1;
1660 foreach my $bound (@$bind) {
1662 my $attributes = {};
1663 my ($column_name, $data_index) = @$bound;
1665 if( $bind_attributes ) {
1666 $attributes = $bind_attributes->{$column_name}
1667 if defined $bind_attributes->{$column_name};
1670 my @data = map { $_->[$data_index] } @$data;
1672 $sth->bind_param_array(
1675 (%$attributes ? $attributes : ()),
1677 $placeholder_index++;
1681 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1683 my $err = $@ || $sth->errstr;
1685 # Statement must finish even if there was an exception.
1686 eval { $sth->finish };
1687 $err = $@ unless $err;
1691 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1693 $self->throw_exception("Unexpected populate error: $err")
1694 if ($i > $#$tuple_status);
1696 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1697 ($tuple_status->[$i][1] || $err),
1698 Data::Dumper::Concise::Dumper({
1699 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1706 sub _dbh_execute_array {
1707 my ($self, $sth, $tuple_status, @extra) = @_;
1709 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1712 sub _dbh_execute_inserts_with_no_binds {
1713 my ($self, $sth, $count) = @_;
1716 my $dbh = $self->_get_dbh;
1717 local $dbh->{RaiseError} = 1;
1718 local $dbh->{PrintError} = 0;
1720 $sth->execute foreach 1..$count;
1724 # Make sure statement is finished even if there was an exception.
1725 eval { $sth->finish };
1726 $exception = $@ unless $exception;
1728 $self->throw_exception($exception) if $exception;
1734 my ($self, $source, @args) = @_;
1736 my $bind_attrs = $self->source_bind_attributes($source);
1738 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1743 my ($self, $source, @args) = @_;
1745 my $bind_attrs = $self->source_bind_attributes($source);
1747 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1750 # We were sent here because the $rs contains a complex search
1751 # which will require a subquery to select the correct rows
1752 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1754 # Generating a single PK column subquery is trivial and supported
1755 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1756 # Look at _multipk_update_delete()
1757 sub _subq_update_delete {
1759 my ($rs, $op, $values) = @_;
1761 my $rsrc = $rs->result_source;
1763 # quick check if we got a sane rs on our hands
1764 my @pcols = $rsrc->_pri_cols;
1766 my $sel = $rs->_resolved_attrs->{select};
1767 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1770 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1772 join ("\x00", sort @$sel )
1774 $self->throw_exception (
1775 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1782 $op eq 'update' ? $values : (),
1783 { $pcols[0] => { -in => $rs->as_query } },
1788 return $self->_multipk_update_delete (@_);
1792 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1793 # resultset update/delete involving subqueries. So by default resort
1794 # to simple (and inefficient) delete_all style per-row opearations,
1795 # while allowing specific storages to override this with a faster
1798 sub _multipk_update_delete {
1799 return shift->_per_row_update_delete (@_);
1802 # This is the default loop used to delete/update rows for multi PK
1803 # resultsets, and used by mysql exclusively (because it can't do anything
1806 # We do not use $row->$op style queries, because resultset update/delete
1807 # is not expected to cascade (this is what delete_all/update_all is for).
1809 # There should be no race conditions as the entire operation is rolled
1812 sub _per_row_update_delete {
1814 my ($rs, $op, $values) = @_;
1816 my $rsrc = $rs->result_source;
1817 my @pcols = $rsrc->_pri_cols;
1819 my $guard = $self->txn_scope_guard;
1821 # emulate the return value of $sth->execute for non-selects
1822 my $row_cnt = '0E0';
1824 my $subrs_cur = $rs->cursor;
1825 my @all_pk = $subrs_cur->all;
1826 for my $pks ( @all_pk) {
1829 for my $i (0.. $#pcols) {
1830 $cond->{$pcols[$i]} = $pks->[$i];
1835 $op eq 'update' ? $values : (),
1849 $self->_execute($self->_select_args(@_));
1852 sub _select_args_to_query {
1855 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $rs_attrs, $rows, $offset)
1856 # = $self->_select_args($ident, $select, $cond, $attrs);
1857 my ($op, $bind, $ident, $bind_attrs, @args) =
1858 $self->_select_args(@_);
1860 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
1861 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1862 $prepared_bind ||= [];
1865 ? ($sql, $prepared_bind, $bind_attrs)
1866 : \[ "($sql)", @$prepared_bind ]
1871 my ($self, $ident, $select, $where, $attrs) = @_;
1873 my $sql_maker = $self->sql_maker;
1874 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1881 $rs_alias && $alias2source->{$rs_alias}
1882 ? ( _rsroot_source_handle => $alias2source->{$rs_alias}->handle )
1887 # calculate bind_attrs before possible $ident mangling
1888 my $bind_attrs = {};
1889 for my $alias (keys %$alias2source) {
1890 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1891 for my $col (keys %$bindtypes) {
1893 my $fqcn = join ('.', $alias, $col);
1894 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1896 # Unqialified column names are nice, but at the same time can be
1897 # rather ambiguous. What we do here is basically go along with
1898 # the loop, adding an unqualified column slot to $bind_attrs,
1899 # alongside the fully qualified name. As soon as we encounter
1900 # another column by that name (which would imply another table)
1901 # we unset the unqualified slot and never add any info to it
1902 # to avoid erroneous type binding. If this happens the users
1903 # only choice will be to fully qualify his column name
1905 if (exists $bind_attrs->{$col}) {
1906 $bind_attrs->{$col} = {};
1909 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1916 $attrs->{software_limit}
1918 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1920 $attrs->{software_limit} = 1;
1923 $self->throw_exception("rows attribute must be positive if present")
1924 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1926 # MySQL actually recommends this approach. I cringe.
1927 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1932 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1933 # storage, unless software limit was requested
1936 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1938 # grouped prefetch (to satisfy group_by == select)
1939 ( $attrs->{group_by}
1941 @{$attrs->{group_by}}
1943 $attrs->{_prefetch_select}
1945 @{$attrs->{_prefetch_select}}
1948 ($ident, $select, $where, $attrs)
1949 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1951 elsif (! $attrs->{software_limit} ) {
1952 push @limit, $attrs->{rows}, $attrs->{offset};
1955 # try to simplify the joinmap further (prune unreferenced type-single joins)
1956 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1959 # This would be the point to deflate anything found in $where
1960 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1961 # expect a row object. And all we have is a resultsource (it is trivial
1962 # to extract deflator coderefs via $alias2source above).
1964 # I don't see a way forward other than changing the way deflators are
1965 # invoked, and that's just bad...
1968 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $attrs, @limit);
1971 # Returns a counting SELECT for a simple count
1972 # query. Abstracted so that a storage could override
1973 # this to { count => 'firstcol' } or whatever makes
1974 # sense as a performance optimization
1976 #my ($self, $source, $rs_attrs) = @_;
1977 return { count => '*' };
1981 sub source_bind_attributes {
1982 my ($self, $source) = @_;
1984 my $bind_attributes;
1985 foreach my $column ($source->columns) {
1987 my $data_type = $source->column_info($column)->{data_type} || '';
1988 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1992 return $bind_attributes;
1999 =item Arguments: $ident, $select, $condition, $attrs
2003 Handle a SQL select statement.
2009 my ($ident, $select, $condition, $attrs) = @_;
2010 return $self->cursor_class->new($self, \@_, $attrs);
2015 my ($rv, $sth, @bind) = $self->_select(@_);
2016 my @row = $sth->fetchrow_array;
2017 my @nextrow = $sth->fetchrow_array if @row;
2018 if(@row && @nextrow) {
2019 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2021 # Need to call finish() to work round broken DBDs
2030 =item Arguments: $sql
2034 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2039 my ($self, $dbh, $sql) = @_;
2041 # 3 is the if_active parameter which avoids active sth re-use
2042 my $sth = $self->disable_sth_caching
2043 ? $dbh->prepare($sql)
2044 : $dbh->prepare_cached($sql, {}, 3);
2046 # XXX You would think RaiseError would make this impossible,
2047 # but apparently that's not true :(
2048 $self->throw_exception($dbh->errstr) if !$sth;
2054 my ($self, $sql) = @_;
2055 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2058 sub _dbh_columns_info_for {
2059 my ($self, $dbh, $table) = @_;
2061 if ($dbh->can('column_info')) {
2064 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2065 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2067 while ( my $info = $sth->fetchrow_hashref() ){
2069 $column_info{data_type} = $info->{TYPE_NAME};
2070 $column_info{size} = $info->{COLUMN_SIZE};
2071 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2072 $column_info{default_value} = $info->{COLUMN_DEF};
2073 my $col_name = $info->{COLUMN_NAME};
2074 $col_name =~ s/^\"(.*)\"$/$1/;
2076 $result{$col_name} = \%column_info;
2079 return \%result if !$@ && scalar keys %result;
2083 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2085 my @columns = @{$sth->{NAME_lc}};
2086 for my $i ( 0 .. $#columns ){
2088 $column_info{data_type} = $sth->{TYPE}->[$i];
2089 $column_info{size} = $sth->{PRECISION}->[$i];
2090 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2092 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2093 $column_info{data_type} = $1;
2094 $column_info{size} = $2;
2097 $result{$columns[$i]} = \%column_info;
2101 foreach my $col (keys %result) {
2102 my $colinfo = $result{$col};
2103 my $type_num = $colinfo->{data_type};
2105 if(defined $type_num && $dbh->can('type_info')) {
2106 my $type_info = $dbh->type_info($type_num);
2107 $type_name = $type_info->{TYPE_NAME} if $type_info;
2108 $colinfo->{data_type} = $type_name if $type_name;
2115 sub columns_info_for {
2116 my ($self, $table) = @_;
2117 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2120 =head2 last_insert_id
2122 Return the row id of the last insert.
2126 sub _dbh_last_insert_id {
2127 my ($self, $dbh, $source, $col) = @_;
2129 my $id = eval { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2131 return $id if defined $id;
2133 my $class = ref $self;
2134 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2137 sub last_insert_id {
2139 $self->_dbh_last_insert_id ($self->_dbh, @_);
2142 =head2 _native_data_type
2146 =item Arguments: $type_name
2150 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2151 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2152 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2154 The default implementation returns C<undef>, implement in your Storage driver if
2155 you need this functionality.
2157 Should map types from other databases to the native RDBMS type, for example
2158 C<VARCHAR2> to C<VARCHAR>.
2160 Types with modifiers should map to the underlying data type. For example,
2161 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2163 Composite types should map to the container type, for example
2164 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2168 sub _native_data_type {
2169 #my ($self, $data_type) = @_;
2173 # Check if placeholders are supported at all
2174 sub _placeholders_supported {
2176 my $dbh = $self->_get_dbh;
2178 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2179 # but it is inaccurate more often than not
2181 local $dbh->{PrintError} = 0;
2182 local $dbh->{RaiseError} = 1;
2183 $dbh->do('select ?', {}, 1);
2188 # Check if placeholders bound to non-string types throw exceptions
2190 sub _typeless_placeholders_supported {
2192 my $dbh = $self->_get_dbh;
2195 local $dbh->{PrintError} = 0;
2196 local $dbh->{RaiseError} = 1;
2197 # this specifically tests a bind that is NOT a string
2198 $dbh->do('select 1 where 1 = ?', {}, 1);
2205 Returns the database driver name.
2210 shift->_get_dbh->{Driver}->{Name};
2213 =head2 bind_attribute_by_data_type
2215 Given a datatype from column info, returns a database specific bind
2216 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2217 let the database planner just handle it.
2219 Generally only needed for special case column types, like bytea in postgres.
2223 sub bind_attribute_by_data_type {
2227 =head2 is_datatype_numeric
2229 Given a datatype from column_info, returns a boolean value indicating if
2230 the current RDBMS considers it a numeric value. This controls how
2231 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2232 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2233 be performed instead of the usual C<eq>.
2237 sub is_datatype_numeric {
2238 my ($self, $dt) = @_;
2240 return 0 unless $dt;
2242 return $dt =~ /^ (?:
2243 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2248 =head2 create_ddl_dir
2252 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2256 Creates a SQL file based on the Schema, for each of the specified
2257 database engines in C<\@databases> in the given directory.
2258 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2260 Given a previous version number, this will also create a file containing
2261 the ALTER TABLE statements to transform the previous schema into the
2262 current one. Note that these statements may contain C<DROP TABLE> or
2263 C<DROP COLUMN> statements that can potentially destroy data.
2265 The file names are created using the C<ddl_filename> method below, please
2266 override this method in your schema if you would like a different file
2267 name format. For the ALTER file, the same format is used, replacing
2268 $version in the name with "$preversion-$version".
2270 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2271 The most common value for this would be C<< { add_drop_table => 1 } >>
2272 to have the SQL produced include a C<DROP TABLE> statement for each table
2273 created. For quoting purposes supply C<quote_table_names> and
2274 C<quote_field_names>.
2276 If no arguments are passed, then the following default values are assumed:
2280 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2282 =item version - $schema->schema_version
2284 =item directory - './'
2286 =item preversion - <none>
2290 By default, C<\%sqlt_args> will have
2292 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2294 merged with the hash passed in. To disable any of those features, pass in a
2295 hashref like the following
2297 { ignore_constraint_names => 0, # ... other options }
2300 WARNING: You are strongly advised to check all SQL files created, before applying
2305 sub create_ddl_dir {
2306 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2309 carp "No directory given, using ./\n";
2312 -d $dir or File::Path::mkpath($dir)
2313 or $self->throw_exception("create_ddl_dir: $! creating dir '$dir'");
2316 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2318 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2319 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2321 my $schema_version = $schema->schema_version || '1.x';
2322 $version ||= $schema_version;
2325 add_drop_table => 1,
2326 ignore_constraint_names => 1,
2327 ignore_index_names => 1,
2331 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2332 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2335 my $sqlt = SQL::Translator->new( $sqltargs );
2337 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2338 my $sqlt_schema = $sqlt->translate({ data => $schema })
2339 or $self->throw_exception ($sqlt->error);
2341 foreach my $db (@$databases) {
2343 $sqlt->{schema} = $sqlt_schema;
2344 $sqlt->producer($db);
2347 my $filename = $schema->ddl_filename($db, $version, $dir);
2348 if (-e $filename && ($version eq $schema_version )) {
2349 # if we are dumping the current version, overwrite the DDL
2350 carp "Overwriting existing DDL file - $filename";
2354 my $output = $sqlt->translate;
2356 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2359 if(!open($file, ">$filename")) {
2360 $self->throw_exception("Can't open $filename for writing ($!)");
2363 print $file $output;
2366 next unless ($preversion);
2368 require SQL::Translator::Diff;
2370 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2371 if(!-e $prefilename) {
2372 carp("No previous schema file found ($prefilename)");
2376 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2378 carp("Overwriting existing diff file - $difffile");
2384 my $t = SQL::Translator->new($sqltargs);
2389 or $self->throw_exception ($t->error);
2391 my $out = $t->translate( $prefilename )
2392 or $self->throw_exception ($t->error);
2394 $source_schema = $t->schema;
2396 $source_schema->name( $prefilename )
2397 unless ( $source_schema->name );
2400 # The "new" style of producers have sane normalization and can support
2401 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2402 # And we have to diff parsed SQL against parsed SQL.
2403 my $dest_schema = $sqlt_schema;
2405 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2406 my $t = SQL::Translator->new($sqltargs);
2411 or $self->throw_exception ($t->error);
2413 my $out = $t->translate( $filename )
2414 or $self->throw_exception ($t->error);
2416 $dest_schema = $t->schema;
2418 $dest_schema->name( $filename )
2419 unless $dest_schema->name;
2422 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2426 if(!open $file, ">$difffile") {
2427 $self->throw_exception("Can't write to $difffile ($!)");
2435 =head2 deployment_statements
2439 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2443 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2445 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2446 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2448 C<$directory> is used to return statements from files in a previously created
2449 L</create_ddl_dir> directory and is optional. The filenames are constructed
2450 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2452 If no C<$directory> is specified then the statements are constructed on the
2453 fly using L<SQL::Translator> and C<$version> is ignored.
2455 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2459 sub deployment_statements {
2460 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2461 $type ||= $self->sqlt_type;
2462 $version ||= $schema->schema_version || '1.x';
2464 my $filename = $schema->ddl_filename($type, $version, $dir);
2468 open($file, "<$filename")
2469 or $self->throw_exception("Can't open $filename ($!)");
2472 return join('', @rows);
2475 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2476 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2479 # sources needs to be a parser arg, but for simplicty allow at top level
2481 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2482 if exists $sqltargs->{sources};
2484 my $tr = SQL::Translator->new(
2485 producer => "SQL::Translator::Producer::${type}",
2487 parser => 'SQL::Translator::Parser::DBIx::Class',
2494 @ret = $tr->translate;
2497 $ret[0] = $tr->translate;
2500 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2501 unless (@ret && defined $ret[0]);
2503 return $wa ? @ret : $ret[0];
2507 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2510 return if($line =~ /^--/);
2512 # next if($line =~ /^DROP/m);
2513 return if($line =~ /^BEGIN TRANSACTION/m);
2514 return if($line =~ /^COMMIT/m);
2515 return if $line =~ /^\s+$/; # skip whitespace only
2516 $self->_query_start($line);
2518 # do a dbh_do cycle here, as we need some error checking in
2519 # place (even though we will ignore errors)
2520 $self->dbh_do (sub { $_[1]->do($line) });
2523 carp qq{$@ (running "${line}")};
2525 $self->_query_end($line);
2527 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2528 if (@statements > 1) {
2529 foreach my $statement (@statements) {
2530 $deploy->( $statement );
2533 elsif (@statements == 1) {
2534 foreach my $line ( split(";\n", $statements[0])) {
2540 =head2 datetime_parser
2542 Returns the datetime parser class
2546 sub datetime_parser {
2548 return $self->{datetime_parser} ||= do {
2549 $self->build_datetime_parser(@_);
2553 =head2 datetime_parser_type
2555 Defines (returns) the datetime parser class - currently hardwired to
2556 L<DateTime::Format::MySQL>
2560 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2562 =head2 build_datetime_parser
2564 See L</datetime_parser>
2568 sub build_datetime_parser {
2570 my $type = $self->datetime_parser_type(@_);
2571 $self->ensure_class_loaded ($type);
2576 =head2 is_replicating
2578 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2579 replicate from a master database. Default is undef, which is the result
2580 returned by databases that don't support replication.
2584 sub is_replicating {
2589 =head2 lag_behind_master
2591 Returns a number that represents a certain amount of lag behind a master db
2592 when a given storage is replicating. The number is database dependent, but
2593 starts at zero and increases with the amount of lag. Default in undef
2597 sub lag_behind_master {
2601 =head2 relname_to_table_alias
2605 =item Arguments: $relname, $join_count
2609 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2612 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2613 way these aliases are named.
2615 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2616 otherwise C<"$relname">.
2620 sub relname_to_table_alias {
2621 my ($self, $relname, $join_count) = @_;
2623 my $alias = ($join_count && $join_count > 1 ?
2624 join('_', $relname, $join_count) : $relname);
2633 =head2 DBIx::Class and AutoCommit
2635 DBIx::Class can do some wonderful magic with handling exceptions,
2636 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2637 (the default) combined with C<txn_do> for transaction support.
2639 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2640 in an assumed transaction between commits, and you're telling us you'd
2641 like to manage that manually. A lot of the magic protections offered by
2642 this module will go away. We can't protect you from exceptions due to database
2643 disconnects because we don't know anything about how to restart your
2644 transactions. You're on your own for handling all sorts of exceptional
2645 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2651 Matt S. Trout <mst@shadowcatsystems.co.uk>
2653 Andy Grundman <andy@hybridized.org>
2657 You may distribute this code under the same terms as Perl itself.