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' =>
23 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
24 _conn_tid transaction_depth _dbh_autocommit _driver_determined 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/
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) {
162 %{ $dbh->{CachedKids} } = ();
170 sub _preserve_foreign_dbh {
173 return unless $self->_dbh;
177 return unless $self->_dbh;
183 # handle pid changes correctly - do not destroy parent's connection
187 return if ( defined $self->_conn_pid and $self->_conn_pid == $$ );
189 $self->_dbh->{InactiveDestroy} = 1;
196 # very similar to above, but seems to FAIL if I set InactiveDestroy
200 if ( ! defined $self->_conn_tid ) {
203 elsif ( $self->_conn_tid == threads->tid ) {
204 return; # same thread
207 #$self->_dbh->{InactiveDestroy} = 1; # why does t/51threads.t fail...?
217 This method is normally called by L<DBIx::Class::Schema/connection>, which
218 encapsulates its argument list in an arrayref before passing them here.
220 The argument list may contain:
226 The same 4-element argument set one would normally pass to
227 L<DBI/connect>, optionally followed by
228 L<extra attributes|/DBIx::Class specific connection attributes>
229 recognized by DBIx::Class:
231 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
235 A single code reference which returns a connected
236 L<DBI database handle|DBI/connect> optionally followed by
237 L<extra attributes|/DBIx::Class specific connection attributes> recognized
240 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
244 A single hashref with all the attributes and the dsn/user/password
247 $connect_info_args = [{
255 $connect_info_args = [{
256 dbh_maker => sub { DBI->connect (...) },
261 This is particularly useful for L<Catalyst> based applications, allowing the
262 following config (L<Config::General> style):
267 dsn dbi:mysql:database=test
274 The C<dsn>/C<user>/C<password> combination can be substituted by the
275 C<dbh_maker> key whose value is a coderef that returns a connected
276 L<DBI database handle|DBI/connect>
280 Please note that the L<DBI> docs recommend that you always explicitly
281 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
282 recommends that it be set to I<1>, and that you perform transactions
283 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
284 to I<1> if you do not do explicitly set it to zero. This is the default
285 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
287 =head3 DBIx::Class specific connection attributes
289 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
290 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
291 the following connection options. These options can be mixed in with your other
292 L<DBI> connection attributes, or placed in a separate hashref
293 (C<\%extra_attributes>) as shown above.
295 Every time C<connect_info> is invoked, any previous settings for
296 these options will be cleared before setting the new ones, regardless of
297 whether any options are specified in the new C<connect_info>.
304 Specifies things to do immediately after connecting or re-connecting to
305 the database. Its value may contain:
311 This contains one SQL statement to execute.
313 =item an array reference
315 This contains SQL statements to execute in order. Each element contains
316 a string or a code reference that returns a string.
318 =item a code reference
320 This contains some code to execute. Unlike code references within an
321 array reference, its return value is ignored.
325 =item on_disconnect_do
327 Takes arguments in the same form as L</on_connect_do> and executes them
328 immediately before disconnecting from the database.
330 Note, this only runs if you explicitly call L</disconnect> on the
333 =item on_connect_call
335 A more generalized form of L</on_connect_do> that calls the specified
336 C<connect_call_METHOD> methods in your storage driver.
338 on_connect_do => 'select 1'
342 on_connect_call => [ [ do_sql => 'select 1' ] ]
344 Its values may contain:
350 Will call the C<connect_call_METHOD> method.
352 =item a code reference
354 Will execute C<< $code->($storage) >>
356 =item an array reference
358 Each value can be a method name or code reference.
360 =item an array of arrays
362 For each array, the first item is taken to be the C<connect_call_> method name
363 or code reference, and the rest are parameters to it.
367 Some predefined storage methods you may use:
373 Executes a SQL string or a code reference that returns a SQL string. This is
374 what L</on_connect_do> and L</on_disconnect_do> use.
382 Will execute the scalar as SQL.
386 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
387 attributes hashref and bind values.
389 =item a code reference
391 Will execute C<< $code->($storage) >> and execute the return array refs as
398 Execute any statements necessary to initialize the database session to return
399 and accept datetime/timestamp values used with
400 L<DBIx::Class::InflateColumn::DateTime>.
402 Only necessary for some databases, see your specific storage driver for
403 implementation details.
407 =item on_disconnect_call
409 Takes arguments in the same form as L</on_connect_call> and executes them
410 immediately before disconnecting from the database.
412 Calls the C<disconnect_call_METHOD> methods as opposed to the
413 C<connect_call_METHOD> methods called by L</on_connect_call>.
415 Note, this only runs if you explicitly call L</disconnect> on the
418 =item disable_sth_caching
420 If set to a true value, this option will disable the caching of
421 statement handles via L<DBI/prepare_cached>.
425 Sets the limit dialect. This is useful for JDBC-bridge among others
426 where the remote SQL-dialect cannot be determined by the name of the
427 driver alone. See also L<SQL::Abstract::Limit>.
431 Specifies what characters to use to quote table and column names. If
432 you use this you will want to specify L</name_sep> as well.
434 C<quote_char> expects either a single character, in which case is it
435 is placed on either side of the table/column name, or an arrayref of length
436 2 in which case the table/column name is placed between the elements.
438 For example under MySQL you should use C<< quote_char => '`' >>, and for
439 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
443 This only needs to be used in conjunction with C<quote_char>, and is used to
444 specify the character that separates elements (schemas, tables, columns) from
445 each other. In most cases this is simply a C<.>.
447 The consequences of not supplying this value is that L<SQL::Abstract>
448 will assume DBIx::Class' uses of aliases to be complete column
449 names. The output will look like I<"me.name"> when it should actually
454 This Storage driver normally installs its own C<HandleError>, sets
455 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
456 all database handles, including those supplied by a coderef. It does this
457 so that it can have consistent and useful error behavior.
459 If you set this option to a true value, Storage will not do its usual
460 modifications to the database handle's attributes, and instead relies on
461 the settings in your connect_info DBI options (or the values you set in
462 your connection coderef, in the case that you are connecting via coderef).
464 Note that your custom settings can cause Storage to malfunction,
465 especially if you set a C<HandleError> handler that suppresses exceptions
466 and/or disable C<RaiseError>.
470 If this option is true, L<DBIx::Class> will use savepoints when nesting
471 transactions, making it possible to recover from failure in the inner
472 transaction without having to abort all outer transactions.
476 Use this argument to supply a cursor class other than the default
477 L<DBIx::Class::Storage::DBI::Cursor>.
481 Some real-life examples of arguments to L</connect_info> and
482 L<DBIx::Class::Schema/connect>
484 # Simple SQLite connection
485 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
488 ->connect_info([ sub { DBI->connect(...) } ]);
490 # Connect via subref in hashref
492 dbh_maker => sub { DBI->connect(...) },
493 on_connect_do => 'alter session ...',
496 # A bit more complicated
503 { quote_char => q{"}, name_sep => q{.} },
507 # Equivalent to the previous example
513 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
517 # Same, but with hashref as argument
518 # See parse_connect_info for explanation
521 dsn => 'dbi:Pg:dbname=foo',
523 password => 'my_pg_password',
530 # Subref + DBIx::Class-specific connection options
533 sub { DBI->connect(...) },
537 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
538 disable_sth_caching => 1,
548 my ($self, $info) = @_;
550 return $self->_connect_info if !$info;
552 $self->_connect_info($info); # copy for _connect_info
554 $info = $self->_normalize_connect_info($info)
555 if ref $info eq 'ARRAY';
557 for my $storage_opt (keys %{ $info->{storage_options} }) {
558 my $value = $info->{storage_options}{$storage_opt};
560 $self->$storage_opt($value);
563 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
564 # the new set of options
565 $self->_sql_maker(undef);
566 $self->_sql_maker_opts({});
568 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
569 my $value = $info->{sql_maker_options}{$sql_maker_opt};
571 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
575 %{ $self->_default_dbi_connect_attributes || {} },
576 %{ $info->{attributes} || {} },
579 my @args = @{ $info->{arguments} };
581 $self->_dbi_connect_info([@args,
582 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
584 return $self->_connect_info;
587 sub _normalize_connect_info {
588 my ($self, $info_arg) = @_;
591 my @args = @$info_arg; # take a shallow copy for further mutilation
593 # combine/pre-parse arguments depending on invocation style
596 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
597 %attrs = %{ $args[1] || {} };
600 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
601 %attrs = %{$args[0]};
603 if (my $code = delete $attrs{dbh_maker}) {
606 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
609 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
610 . "to the result of 'dbh_maker'",
612 join (', ', map { "'$_'" } (@ignored) ),
617 @args = delete @attrs{qw/dsn user password/};
620 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
622 % { $args[3] || {} },
623 % { $args[4] || {} },
625 @args = @args[0,1,2];
628 $info{arguments} = \@args;
630 my @storage_opts = grep exists $attrs{$_},
631 @storage_options, 'cursor_class';
633 @{ $info{storage_options} }{@storage_opts} =
634 delete @attrs{@storage_opts} if @storage_opts;
636 my @sql_maker_opts = grep exists $attrs{$_},
637 qw/limit_dialect quote_char name_sep/;
639 @{ $info{sql_maker_options} }{@sql_maker_opts} =
640 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
642 $info{attributes} = \%attrs if %attrs;
647 sub _default_dbi_connect_attributes {
657 This method is deprecated in favour of setting via L</connect_info>.
661 =head2 on_disconnect_do
663 This method is deprecated in favour of setting via L</connect_info>.
667 sub _parse_connect_do {
668 my ($self, $type) = @_;
670 my $val = $self->$type;
671 return () if not defined $val;
676 push @res, [ 'do_sql', $val ];
677 } elsif (ref($val) eq 'CODE') {
679 } elsif (ref($val) eq 'ARRAY') {
680 push @res, map { [ 'do_sql', $_ ] } @$val;
682 $self->throw_exception("Invalid type for $type: ".ref($val));
690 Arguments: ($subref | $method_name), @extra_coderef_args?
692 Execute the given $subref or $method_name using the new exception-based
693 connection management.
695 The first two arguments will be the storage object that C<dbh_do> was called
696 on and a database handle to use. Any additional arguments will be passed
697 verbatim to the called subref as arguments 2 and onwards.
699 Using this (instead of $self->_dbh or $self->dbh) ensures correct
700 exception handling and reconnection (or failover in future subclasses).
702 Your subref should have no side-effects outside of the database, as
703 there is the potential for your subref to be partially double-executed
704 if the database connection was stale/dysfunctional.
708 my @stuff = $schema->storage->dbh_do(
710 my ($storage, $dbh, @cols) = @_;
711 my $cols = join(q{, }, @cols);
712 $dbh->selectrow_array("SELECT $cols FROM foo");
723 my $dbh = $self->_get_dbh;
725 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
726 || $self->{transaction_depth};
728 local $self->{_in_dbh_do} = 1;
731 my $want_array = wantarray;
736 @result = $self->$code($dbh, @_);
738 elsif(defined $want_array) {
739 $result[0] = $self->$code($dbh, @_);
742 $self->$code($dbh, @_);
746 # ->connected might unset $@ - copy
748 if(!$exception) { return $want_array ? @result : $result[0] }
750 $self->throw_exception($exception) if $self->connected;
752 # We were not connected - reconnect and retry, but let any
753 # exception fall right through this time
754 carp "Retrying $code after catching disconnected exception: $exception"
755 if $ENV{DBIC_DBIRETRY_DEBUG};
756 $self->_populate_dbh;
757 $self->$code($self->_dbh, @_);
760 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
761 # It also informs dbh_do to bypass itself while under the direction of txn_do,
762 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
767 ref $coderef eq 'CODE' or $self->throw_exception
768 ('$coderef must be a CODE reference');
770 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
772 local $self->{_in_dbh_do} = 1;
775 my $want_array = wantarray;
786 @result = $coderef->(@args);
788 elsif(defined $want_array) {
789 $result[0] = $coderef->(@args);
799 if(! defined $exception) { return $want_array ? @result : $result[0] }
801 if($tried++ || $self->connected) {
802 my $rollback_exception;
803 try { $self->txn_rollback } catch { $rollback_exception = shift };
804 if(defined $rollback_exception) {
805 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
806 $self->throw_exception($exception) # propagate nested rollback
807 if $rollback_exception =~ /$exception_class/;
809 $self->throw_exception(
810 "Transaction aborted: ${exception}. "
811 . "Rollback failed: ${rollback_exception}"
814 $self->throw_exception($exception)
817 # We were not connected, and was first try - reconnect and retry
819 carp "Retrying $coderef after catching disconnected exception: $exception"
820 if $ENV{DBIC_DBIRETRY_DEBUG};
821 $self->_populate_dbh;
827 Our C<disconnect> method also performs a rollback first if the
828 database is not in C<AutoCommit> mode.
838 push @actions, ( $self->on_disconnect_call || () );
839 push @actions, $self->_parse_connect_do ('on_disconnect_do');
841 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
843 $self->_dbh_rollback unless $self->_dbh_autocommit;
845 %{ $self->_dbh->{CachedKids} } = ();
846 $self->_dbh->disconnect;
852 =head2 with_deferred_fk_checks
856 =item Arguments: C<$coderef>
858 =item Return Value: The return value of $coderef
862 Storage specific method to run the code ref with FK checks deferred or
863 in MySQL's case disabled entirely.
867 # Storage subclasses should override this
868 sub with_deferred_fk_checks {
869 my ($self, $sub) = @_;
877 =item Arguments: none
879 =item Return Value: 1|0
883 Verifies that the current database handle is active and ready to execute
884 an SQL statement (e.g. the connection did not get stale, server is still
885 answering, etc.) This method is used internally by L</dbh>.
891 return 0 unless $self->_seems_connected;
894 local $self->_dbh->{RaiseError} = 1;
899 sub _seems_connected {
902 $self->_preserve_foreign_dbh;
904 my $dbh = $self->_dbh
907 return $dbh->FETCH('Active');
913 my $dbh = $self->_dbh or return 0;
918 sub ensure_connected {
921 unless ($self->connected) {
922 $self->_populate_dbh;
928 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
929 is guaranteed to be healthy by implicitly calling L</connected>, and if
930 necessary performing a reconnection before returning. Keep in mind that this
931 is very B<expensive> on some database engines. Consider using L</dbh_do>
939 if (not $self->_dbh) {
940 $self->_populate_dbh;
942 $self->ensure_connected;
947 # this is the internal "get dbh or connect (don't check)" method
950 $self->_preserve_foreign_dbh;
951 $self->_populate_dbh unless $self->_dbh;
955 sub _sql_maker_args {
960 array_datatypes => 1,
961 limit_dialect => $self->_get_dbh,
962 %{$self->_sql_maker_opts}
968 unless ($self->_sql_maker) {
969 my $sql_maker_class = $self->sql_maker_class;
970 $self->ensure_class_loaded ($sql_maker_class);
971 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
973 return $self->_sql_maker;
976 # nothing to do by default
983 my @info = @{$self->_dbi_connect_info || []};
984 $self->_dbh(undef); # in case ->connected failed we might get sent here
985 $self->_server_info_hash (undef);
986 $self->_dbh($self->_connect(@info));
988 $self->_conn_pid($$);
989 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
991 $self->_determine_driver;
993 # Always set the transaction depth on connect, since
994 # there is no transaction in progress by definition
995 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
997 $self->_run_connection_actions unless $self->{_in_determine_driver};
1000 sub _run_connection_actions {
1004 push @actions, ( $self->on_connect_call || () );
1005 push @actions, $self->_parse_connect_do ('on_connect_do');
1007 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1013 unless ($self->_server_info_hash) {
1017 my $server_version = do {
1018 local $@; # might be happenin in some sort of destructor
1019 try { $self->_get_server_version };
1022 if (defined $server_version) {
1023 $info{dbms_version} = $server_version;
1025 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1026 my @verparts = split (/\./, $numeric_version);
1032 # consider only up to 3 version parts, iff not more than 3 digits
1034 while (@verparts && @use_parts < 3) {
1035 my $p = shift @verparts;
1037 push @use_parts, $p;
1039 push @use_parts, 0 while @use_parts < 3;
1041 $info{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1045 $self->_server_info_hash(\%info);
1048 return $self->_server_info_hash
1051 sub _get_server_version {
1052 shift->_get_dbh->get_info(18);
1055 sub _determine_driver {
1058 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1059 my $started_connected = 0;
1060 local $self->{_in_determine_driver} = 1;
1062 if (ref($self) eq __PACKAGE__) {
1064 if ($self->_dbh) { # we are connected
1065 $driver = $self->_dbh->{Driver}{Name};
1066 $started_connected = 1;
1068 # if connect_info is a CODEREF, we have no choice but to connect
1069 if (ref $self->_dbi_connect_info->[0] &&
1070 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
1071 $self->_populate_dbh;
1072 $driver = $self->_dbh->{Driver}{Name};
1075 # try to use dsn to not require being connected, the driver may still
1076 # force a connection in _rebless to determine version
1077 # (dsn may not be supplied at all if all we do is make a mock-schema)
1078 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1079 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1080 $driver ||= $ENV{DBI_DRIVER};
1085 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1086 if ($self->load_optional_class($storage_class)) {
1087 mro::set_mro($storage_class, 'c3');
1088 bless $self, $storage_class;
1094 $self->_driver_determined(1);
1096 $self->_init; # run driver-specific initializations
1098 $self->_run_connection_actions
1099 if !$started_connected && defined $self->_dbh;
1103 sub _do_connection_actions {
1105 my $method_prefix = shift;
1108 if (not ref($call)) {
1109 my $method = $method_prefix . $call;
1111 } elsif (ref($call) eq 'CODE') {
1113 } elsif (ref($call) eq 'ARRAY') {
1114 if (ref($call->[0]) ne 'ARRAY') {
1115 $self->_do_connection_actions($method_prefix, $_) for @$call;
1117 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1120 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1126 sub connect_call_do_sql {
1128 $self->_do_query(@_);
1131 sub disconnect_call_do_sql {
1133 $self->_do_query(@_);
1136 # override in db-specific backend when necessary
1137 sub connect_call_datetime_setup { 1 }
1140 my ($self, $action) = @_;
1142 if (ref $action eq 'CODE') {
1143 $action = $action->($self);
1144 $self->_do_query($_) foreach @$action;
1147 # Most debuggers expect ($sql, @bind), so we need to exclude
1148 # the attribute hash which is the second argument to $dbh->do
1149 # furthermore the bind values are usually to be presented
1150 # as named arrayref pairs, so wrap those here too
1151 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1152 my $sql = shift @do_args;
1153 my $attrs = shift @do_args;
1154 my @bind = map { [ undef, $_ ] } @do_args;
1156 $self->_query_start($sql, @bind);
1157 $self->_get_dbh->do($sql, $attrs, @do_args);
1158 $self->_query_end($sql, @bind);
1165 my ($self, @info) = @_;
1167 $self->throw_exception("You failed to provide any connection info")
1170 my ($old_connect_via, $dbh);
1172 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1173 $old_connect_via = $DBI::connect_via;
1174 $DBI::connect_via = 'connect';
1179 if(ref $info[0] eq 'CODE') {
1180 $dbh = $info[0]->();
1183 $dbh = DBI->connect(@info);
1186 if($dbh && !$self->unsafe) {
1187 my $weak_self = $self;
1188 Scalar::Util::weaken($weak_self);
1189 $dbh->{HandleError} = sub {
1191 $weak_self->throw_exception("DBI Exception: $_[0]");
1194 # the handler may be invoked by something totally out of
1196 croak ("DBI Exception: $_[0]");
1199 $dbh->{ShowErrorStatement} = 1;
1200 $dbh->{RaiseError} = 1;
1201 $dbh->{PrintError} = 0;
1207 $DBI::connect_via = $old_connect_via if $old_connect_via;
1209 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1210 if !$dbh || $caught;
1212 $self->_dbh_autocommit($dbh->{AutoCommit});
1218 my ($self, $name) = @_;
1220 $name = $self->_svp_generate_name
1221 unless defined $name;
1223 $self->throw_exception ("You can't use savepoints outside a transaction")
1224 if $self->{transaction_depth} == 0;
1226 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1227 unless $self->can('_svp_begin');
1229 push @{ $self->{savepoints} }, $name;
1231 $self->debugobj->svp_begin($name) if $self->debug;
1233 return $self->_svp_begin($name);
1237 my ($self, $name) = @_;
1239 $self->throw_exception ("You can't use savepoints outside a transaction")
1240 if $self->{transaction_depth} == 0;
1242 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1243 unless $self->can('_svp_release');
1245 if (defined $name) {
1246 $self->throw_exception ("Savepoint '$name' does not exist")
1247 unless grep { $_ eq $name } @{ $self->{savepoints} };
1249 # Dig through the stack until we find the one we are releasing. This keeps
1250 # the stack up to date.
1253 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1255 $name = pop @{ $self->{savepoints} };
1258 $self->debugobj->svp_release($name) if $self->debug;
1260 return $self->_svp_release($name);
1264 my ($self, $name) = @_;
1266 $self->throw_exception ("You can't use savepoints outside a transaction")
1267 if $self->{transaction_depth} == 0;
1269 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1270 unless $self->can('_svp_rollback');
1272 if (defined $name) {
1273 # If they passed us a name, verify that it exists in the stack
1274 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1275 $self->throw_exception("Savepoint '$name' does not exist!");
1278 # Dig through the stack until we find the one we are releasing. This keeps
1279 # the stack up to date.
1280 while(my $s = pop(@{ $self->{savepoints} })) {
1281 last if($s eq $name);
1283 # Add the savepoint back to the stack, as a rollback doesn't remove the
1284 # named savepoint, only everything after it.
1285 push(@{ $self->{savepoints} }, $name);
1287 # We'll assume they want to rollback to the last savepoint
1288 $name = $self->{savepoints}->[-1];
1291 $self->debugobj->svp_rollback($name) if $self->debug;
1293 return $self->_svp_rollback($name);
1296 sub _svp_generate_name {
1299 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1305 # this means we have not yet connected and do not know the AC status
1306 # (e.g. coderef $dbh)
1307 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1309 if($self->{transaction_depth} == 0) {
1310 $self->debugobj->txn_begin()
1312 $self->_dbh_begin_work;
1314 elsif ($self->auto_savepoint) {
1317 $self->{transaction_depth}++;
1320 sub _dbh_begin_work {
1323 # if the user is utilizing txn_do - good for him, otherwise we need to
1324 # ensure that the $dbh is healthy on BEGIN.
1325 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1326 # will be replaced by a failure of begin_work itself (which will be
1327 # then retried on reconnect)
1328 if ($self->{_in_dbh_do}) {
1329 $self->_dbh->begin_work;
1331 $self->dbh_do(sub { $_[1]->begin_work });
1337 if ($self->{transaction_depth} == 1) {
1338 $self->debugobj->txn_commit()
1341 $self->{transaction_depth} = 0
1342 if $self->_dbh_autocommit;
1344 elsif($self->{transaction_depth} > 1) {
1345 $self->{transaction_depth}--;
1347 if $self->auto_savepoint;
1353 my $dbh = $self->_dbh
1354 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1360 my $dbh = $self->_dbh;
1362 if ($self->{transaction_depth} == 1) {
1363 $self->debugobj->txn_rollback()
1365 $self->{transaction_depth} = 0
1366 if $self->_dbh_autocommit;
1367 $self->_dbh_rollback;
1369 elsif($self->{transaction_depth} > 1) {
1370 $self->{transaction_depth}--;
1371 if ($self->auto_savepoint) {
1372 $self->svp_rollback;
1377 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1382 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1383 $error =~ /$exception_class/ and $self->throw_exception($error);
1384 # ensure that a failed rollback resets the transaction depth
1385 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1386 $self->throw_exception($error);
1392 my $dbh = $self->_dbh
1393 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1397 # This used to be the top-half of _execute. It was split out to make it
1398 # easier to override in NoBindVars without duping the rest. It takes up
1399 # all of _execute's args, and emits $sql, @bind.
1400 sub _prep_for_execute {
1401 my ($self, $op, $extra_bind, $ident, $args) = @_;
1403 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1404 $ident = $ident->from();
1407 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1410 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1412 return ($sql, \@bind);
1416 sub _fix_bind_params {
1417 my ($self, @bind) = @_;
1419 ### Turn @bind from something like this:
1420 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1422 ### ( "'1'", "'1'", "'3'" )
1425 if ( defined( $_ && $_->[1] ) ) {
1426 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1433 my ( $self, $sql, @bind ) = @_;
1435 if ( $self->debug ) {
1436 @bind = $self->_fix_bind_params(@bind);
1438 $self->debugobj->query_start( $sql, @bind );
1443 my ( $self, $sql, @bind ) = @_;
1445 if ( $self->debug ) {
1446 @bind = $self->_fix_bind_params(@bind);
1447 $self->debugobj->query_end( $sql, @bind );
1452 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1454 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1456 $self->_query_start( $sql, @$bind );
1458 my $sth = $self->sth($sql,$op);
1460 my $placeholder_index = 1;
1462 foreach my $bound (@$bind) {
1463 my $attributes = {};
1464 my($column_name, @data) = @$bound;
1466 if ($bind_attributes) {
1467 $attributes = $bind_attributes->{$column_name}
1468 if defined $bind_attributes->{$column_name};
1471 foreach my $data (@data) {
1472 my $ref = ref $data;
1473 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1475 $sth->bind_param($placeholder_index, $data, $attributes);
1476 $placeholder_index++;
1480 # Can this fail without throwing an exception anyways???
1481 my $rv = $sth->execute();
1482 $self->throw_exception($sth->errstr) if !$rv;
1484 $self->_query_end( $sql, @$bind );
1486 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1491 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1494 sub _prefetch_insert_auto_nextvals {
1495 my ($self, $source, $to_insert) = @_;
1499 foreach my $col ( $source->columns ) {
1500 if ( !defined $to_insert->{$col} ) {
1501 my $col_info = $source->column_info($col);
1503 if ( $col_info->{auto_nextval} ) {
1504 $upd->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1506 $col_info->{sequence} ||=
1507 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1518 my ($source, $to_insert, $opts) = @_;
1520 my $updated_cols = $self->_prefetch_insert_auto_nextvals (@_);
1522 my $bind_attributes = $self->source_bind_attributes($source);
1524 my ($rv, $sth) = $self->_execute('insert' => [], $source, $bind_attributes, $to_insert, $opts);
1526 if ($opts->{returning}) {
1527 my @ret_cols = @{$opts->{returning}};
1529 my @ret_vals = eval {
1530 local $SIG{__WARN__} = sub {};
1531 my @r = $sth->fetchrow_array;
1537 @ret{@ret_cols} = @ret_vals if (@ret_vals);
1545 return $updated_cols;
1548 ## Currently it is assumed that all values passed will be "normal", i.e. not
1549 ## scalar refs, or at least, all the same type as the first set, the statement is
1550 ## only prepped once.
1552 my ($self, $source, $cols, $data) = @_;
1555 @colvalues{@$cols} = (0..$#$cols);
1557 for my $i (0..$#$cols) {
1558 my $first_val = $data->[0][$i];
1559 next unless ref $first_val eq 'SCALAR';
1561 $colvalues{ $cols->[$i] } = $first_val;
1564 # check for bad data and stringify stringifiable objects
1565 my $bad_slice = sub {
1566 my ($msg, $col_idx, $slice_idx) = @_;
1567 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1571 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1572 Data::Dumper::Concise::Dumper({
1573 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1579 for my $datum_idx (0..$#$data) {
1580 my $datum = $data->[$datum_idx];
1582 for my $col_idx (0..$#$cols) {
1583 my $val = $datum->[$col_idx];
1584 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1585 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1587 if ($is_literal_sql) {
1589 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1591 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1592 $bad_slice->("$reftype reference found where literal SQL expected",
1593 $col_idx, $datum_idx);
1595 elsif ($$val ne $$sqla_bind){
1596 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1597 $col_idx, $datum_idx);
1600 elsif (my $reftype = ref $val) {
1602 if (overload::Method($val, '""')) {
1603 $datum->[$col_idx] = "".$val;
1606 $bad_slice->("$reftype reference found where bind expected",
1607 $col_idx, $datum_idx);
1613 my ($sql, $bind) = $self->_prep_for_execute (
1614 'insert', undef, $source, [\%colvalues]
1618 my $empty_bind = 1 if (not @bind) &&
1619 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1621 if ((not @bind) && (not $empty_bind)) {
1622 $self->throw_exception(
1623 'Cannot insert_bulk without support for placeholders'
1627 # neither _execute_array, nor _execute_inserts_with_no_binds are
1628 # atomic (even if _execute _array is a single call). Thus a safety
1630 my $guard = $self->txn_scope_guard;
1632 $self->_query_start( $sql, ['__BULK__'] );
1633 my $sth = $self->sth($sql);
1636 # bind_param_array doesn't work if there are no binds
1637 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1640 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1641 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1645 $self->_query_end( $sql, ['__BULK__'] );
1649 return (wantarray ? ($rv, $sth, @bind) : $rv);
1652 sub _execute_array {
1653 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1655 ## This must be an arrayref, else nothing works!
1656 my $tuple_status = [];
1658 ## Get the bind_attributes, if any exist
1659 my $bind_attributes = $self->source_bind_attributes($source);
1661 ## Bind the values and execute
1662 my $placeholder_index = 1;
1664 foreach my $bound (@$bind) {
1666 my $attributes = {};
1667 my ($column_name, $data_index) = @$bound;
1669 if( $bind_attributes ) {
1670 $attributes = $bind_attributes->{$column_name}
1671 if defined $bind_attributes->{$column_name};
1674 my @data = map { $_->[$data_index] } @$data;
1676 $sth->bind_param_array(
1679 (%$attributes ? $attributes : ()),
1681 $placeholder_index++;
1685 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1687 my $err = $@ || $sth->errstr;
1689 # Statement must finish even if there was an exception.
1690 eval { $sth->finish };
1691 $err = $@ unless $err;
1695 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1697 $self->throw_exception("Unexpected populate error: $err")
1698 if ($i > $#$tuple_status);
1700 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1701 ($tuple_status->[$i][1] || $err),
1702 Data::Dumper::Concise::Dumper({
1703 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1710 sub _dbh_execute_array {
1711 my ($self, $sth, $tuple_status, @extra) = @_;
1713 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1716 sub _dbh_execute_inserts_with_no_binds {
1717 my ($self, $sth, $count) = @_;
1721 my $dbh = $self->_get_dbh;
1722 local $dbh->{RaiseError} = 1;
1723 local $dbh->{PrintError} = 0;
1725 $sth->execute foreach 1..$count;
1730 # Make sure statement is finished even if there was an exception.
1734 $exception = shift unless defined $exception;
1737 $self->throw_exception($exception) if defined $exception;
1743 my ($self, $source, @args) = @_;
1745 my $bind_attrs = $self->source_bind_attributes($source);
1747 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1752 my ($self, $source, @args) = @_;
1754 my $bind_attrs = $self->source_bind_attributes($source);
1756 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1759 # We were sent here because the $rs contains a complex search
1760 # which will require a subquery to select the correct rows
1761 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1763 # Generating a single PK column subquery is trivial and supported
1764 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1765 # Look at _multipk_update_delete()
1766 sub _subq_update_delete {
1768 my ($rs, $op, $values) = @_;
1770 my $rsrc = $rs->result_source;
1772 # quick check if we got a sane rs on our hands
1773 my @pcols = $rsrc->_pri_cols;
1775 my $sel = $rs->_resolved_attrs->{select};
1776 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1779 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1781 join ("\x00", sort @$sel )
1783 $self->throw_exception (
1784 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1791 $op eq 'update' ? $values : (),
1792 { $pcols[0] => { -in => $rs->as_query } },
1797 return $self->_multipk_update_delete (@_);
1801 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1802 # resultset update/delete involving subqueries. So by default resort
1803 # to simple (and inefficient) delete_all style per-row opearations,
1804 # while allowing specific storages to override this with a faster
1807 sub _multipk_update_delete {
1808 return shift->_per_row_update_delete (@_);
1811 # This is the default loop used to delete/update rows for multi PK
1812 # resultsets, and used by mysql exclusively (because it can't do anything
1815 # We do not use $row->$op style queries, because resultset update/delete
1816 # is not expected to cascade (this is what delete_all/update_all is for).
1818 # There should be no race conditions as the entire operation is rolled
1821 sub _per_row_update_delete {
1823 my ($rs, $op, $values) = @_;
1825 my $rsrc = $rs->result_source;
1826 my @pcols = $rsrc->_pri_cols;
1828 my $guard = $self->txn_scope_guard;
1830 # emulate the return value of $sth->execute for non-selects
1831 my $row_cnt = '0E0';
1833 my $subrs_cur = $rs->cursor;
1834 my @all_pk = $subrs_cur->all;
1835 for my $pks ( @all_pk) {
1838 for my $i (0.. $#pcols) {
1839 $cond->{$pcols[$i]} = $pks->[$i];
1844 $op eq 'update' ? $values : (),
1858 $self->_execute($self->_select_args(@_));
1861 sub _select_args_to_query {
1864 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $rs_attrs, $rows, $offset)
1865 # = $self->_select_args($ident, $select, $cond, $attrs);
1866 my ($op, $bind, $ident, $bind_attrs, @args) =
1867 $self->_select_args(@_);
1869 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
1870 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1871 $prepared_bind ||= [];
1874 ? ($sql, $prepared_bind, $bind_attrs)
1875 : \[ "($sql)", @$prepared_bind ]
1880 my ($self, $ident, $select, $where, $attrs) = @_;
1882 my $sql_maker = $self->sql_maker;
1883 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1890 $rs_alias && $alias2source->{$rs_alias}
1891 ? ( _rsroot_source_handle => $alias2source->{$rs_alias}->handle )
1896 # calculate bind_attrs before possible $ident mangling
1897 my $bind_attrs = {};
1898 for my $alias (keys %$alias2source) {
1899 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1900 for my $col (keys %$bindtypes) {
1902 my $fqcn = join ('.', $alias, $col);
1903 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1905 # Unqialified column names are nice, but at the same time can be
1906 # rather ambiguous. What we do here is basically go along with
1907 # the loop, adding an unqualified column slot to $bind_attrs,
1908 # alongside the fully qualified name. As soon as we encounter
1909 # another column by that name (which would imply another table)
1910 # we unset the unqualified slot and never add any info to it
1911 # to avoid erroneous type binding. If this happens the users
1912 # only choice will be to fully qualify his column name
1914 if (exists $bind_attrs->{$col}) {
1915 $bind_attrs->{$col} = {};
1918 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1925 $attrs->{software_limit}
1927 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1929 $attrs->{software_limit} = 1;
1932 $self->throw_exception("rows attribute must be positive if present")
1933 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1935 # MySQL actually recommends this approach. I cringe.
1936 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1941 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1942 # storage, unless software limit was requested
1945 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1947 # grouped prefetch (to satisfy group_by == select)
1948 ( $attrs->{group_by}
1950 @{$attrs->{group_by}}
1952 $attrs->{_prefetch_select}
1954 @{$attrs->{_prefetch_select}}
1957 ($ident, $select, $where, $attrs)
1958 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1960 elsif (! $attrs->{software_limit} ) {
1961 push @limit, $attrs->{rows}, $attrs->{offset};
1964 # try to simplify the joinmap further (prune unreferenced type-single joins)
1965 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1968 # This would be the point to deflate anything found in $where
1969 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1970 # expect a row object. And all we have is a resultsource (it is trivial
1971 # to extract deflator coderefs via $alias2source above).
1973 # I don't see a way forward other than changing the way deflators are
1974 # invoked, and that's just bad...
1977 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $attrs, @limit);
1980 # Returns a counting SELECT for a simple count
1981 # query. Abstracted so that a storage could override
1982 # this to { count => 'firstcol' } or whatever makes
1983 # sense as a performance optimization
1985 #my ($self, $source, $rs_attrs) = @_;
1986 return { count => '*' };
1990 sub source_bind_attributes {
1991 my ($self, $source) = @_;
1993 my $bind_attributes;
1994 foreach my $column ($source->columns) {
1996 my $data_type = $source->column_info($column)->{data_type} || '';
1997 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
2001 return $bind_attributes;
2008 =item Arguments: $ident, $select, $condition, $attrs
2012 Handle a SQL select statement.
2018 my ($ident, $select, $condition, $attrs) = @_;
2019 return $self->cursor_class->new($self, \@_, $attrs);
2024 my ($rv, $sth, @bind) = $self->_select(@_);
2025 my @row = $sth->fetchrow_array;
2026 my @nextrow = $sth->fetchrow_array if @row;
2027 if(@row && @nextrow) {
2028 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2030 # Need to call finish() to work round broken DBDs
2039 =item Arguments: $sql
2043 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2048 my ($self, $dbh, $sql) = @_;
2050 # 3 is the if_active parameter which avoids active sth re-use
2051 my $sth = $self->disable_sth_caching
2052 ? $dbh->prepare($sql)
2053 : $dbh->prepare_cached($sql, {}, 3);
2055 # XXX You would think RaiseError would make this impossible,
2056 # but apparently that's not true :(
2057 $self->throw_exception($dbh->errstr) if !$sth;
2063 my ($self, $sql) = @_;
2064 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2067 sub _dbh_columns_info_for {
2068 my ($self, $dbh, $table) = @_;
2070 if ($dbh->can('column_info')) {
2073 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2074 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2076 while ( my $info = $sth->fetchrow_hashref() ){
2078 $column_info{data_type} = $info->{TYPE_NAME};
2079 $column_info{size} = $info->{COLUMN_SIZE};
2080 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2081 $column_info{default_value} = $info->{COLUMN_DEF};
2082 my $col_name = $info->{COLUMN_NAME};
2083 $col_name =~ s/^\"(.*)\"$/$1/;
2085 $result{$col_name} = \%column_info;
2088 return \%result if !$@ && scalar keys %result;
2092 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2094 my @columns = @{$sth->{NAME_lc}};
2095 for my $i ( 0 .. $#columns ){
2097 $column_info{data_type} = $sth->{TYPE}->[$i];
2098 $column_info{size} = $sth->{PRECISION}->[$i];
2099 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2101 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2102 $column_info{data_type} = $1;
2103 $column_info{size} = $2;
2106 $result{$columns[$i]} = \%column_info;
2110 foreach my $col (keys %result) {
2111 my $colinfo = $result{$col};
2112 my $type_num = $colinfo->{data_type};
2114 if(defined $type_num && $dbh->can('type_info')) {
2115 my $type_info = $dbh->type_info($type_num);
2116 $type_name = $type_info->{TYPE_NAME} if $type_info;
2117 $colinfo->{data_type} = $type_name if $type_name;
2124 sub columns_info_for {
2125 my ($self, $table) = @_;
2126 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2129 =head2 last_insert_id
2131 Return the row id of the last insert.
2135 sub _dbh_last_insert_id {
2136 my ($self, $dbh, $source, $col) = @_;
2138 my $id = eval { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2140 return $id if defined $id;
2142 my $class = ref $self;
2143 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2146 sub last_insert_id {
2148 $self->_dbh_last_insert_id ($self->_dbh, @_);
2151 =head2 _native_data_type
2155 =item Arguments: $type_name
2159 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2160 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2161 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2163 The default implementation returns C<undef>, implement in your Storage driver if
2164 you need this functionality.
2166 Should map types from other databases to the native RDBMS type, for example
2167 C<VARCHAR2> to C<VARCHAR>.
2169 Types with modifiers should map to the underlying data type. For example,
2170 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2172 Composite types should map to the container type, for example
2173 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2177 sub _native_data_type {
2178 #my ($self, $data_type) = @_;
2182 # Check if placeholders are supported at all
2183 sub _placeholders_supported {
2185 my $dbh = $self->_get_dbh;
2187 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2188 # but it is inaccurate more often than not
2190 local $dbh->{PrintError} = 0;
2191 local $dbh->{RaiseError} = 1;
2192 $dbh->do('select ?', {}, 1);
2197 # Check if placeholders bound to non-string types throw exceptions
2199 sub _typeless_placeholders_supported {
2201 my $dbh = $self->_get_dbh;
2204 local $dbh->{PrintError} = 0;
2205 local $dbh->{RaiseError} = 1;
2206 # this specifically tests a bind that is NOT a string
2207 $dbh->do('select 1 where 1 = ?', {}, 1);
2214 Returns the database driver name.
2219 shift->_get_dbh->{Driver}->{Name};
2222 =head2 bind_attribute_by_data_type
2224 Given a datatype from column info, returns a database specific bind
2225 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2226 let the database planner just handle it.
2228 Generally only needed for special case column types, like bytea in postgres.
2232 sub bind_attribute_by_data_type {
2236 =head2 is_datatype_numeric
2238 Given a datatype from column_info, returns a boolean value indicating if
2239 the current RDBMS considers it a numeric value. This controls how
2240 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2241 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2242 be performed instead of the usual C<eq>.
2246 sub is_datatype_numeric {
2247 my ($self, $dt) = @_;
2249 return 0 unless $dt;
2251 return $dt =~ /^ (?:
2252 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2257 =head2 create_ddl_dir
2261 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2265 Creates a SQL file based on the Schema, for each of the specified
2266 database engines in C<\@databases> in the given directory.
2267 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2269 Given a previous version number, this will also create a file containing
2270 the ALTER TABLE statements to transform the previous schema into the
2271 current one. Note that these statements may contain C<DROP TABLE> or
2272 C<DROP COLUMN> statements that can potentially destroy data.
2274 The file names are created using the C<ddl_filename> method below, please
2275 override this method in your schema if you would like a different file
2276 name format. For the ALTER file, the same format is used, replacing
2277 $version in the name with "$preversion-$version".
2279 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2280 The most common value for this would be C<< { add_drop_table => 1 } >>
2281 to have the SQL produced include a C<DROP TABLE> statement for each table
2282 created. For quoting purposes supply C<quote_table_names> and
2283 C<quote_field_names>.
2285 If no arguments are passed, then the following default values are assumed:
2289 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2291 =item version - $schema->schema_version
2293 =item directory - './'
2295 =item preversion - <none>
2299 By default, C<\%sqlt_args> will have
2301 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2303 merged with the hash passed in. To disable any of those features, pass in a
2304 hashref like the following
2306 { ignore_constraint_names => 0, # ... other options }
2309 WARNING: You are strongly advised to check all SQL files created, before applying
2314 sub create_ddl_dir {
2315 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2318 carp "No directory given, using ./\n";
2321 -d $dir or File::Path::mkpath($dir)
2322 or $self->throw_exception("create_ddl_dir: $! creating dir '$dir'");
2325 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2327 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2328 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2330 my $schema_version = $schema->schema_version || '1.x';
2331 $version ||= $schema_version;
2334 add_drop_table => 1,
2335 ignore_constraint_names => 1,
2336 ignore_index_names => 1,
2340 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2341 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2344 my $sqlt = SQL::Translator->new( $sqltargs );
2346 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2347 my $sqlt_schema = $sqlt->translate({ data => $schema })
2348 or $self->throw_exception ($sqlt->error);
2350 foreach my $db (@$databases) {
2352 $sqlt->{schema} = $sqlt_schema;
2353 $sqlt->producer($db);
2356 my $filename = $schema->ddl_filename($db, $version, $dir);
2357 if (-e $filename && ($version eq $schema_version )) {
2358 # if we are dumping the current version, overwrite the DDL
2359 carp "Overwriting existing DDL file - $filename";
2363 my $output = $sqlt->translate;
2365 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2368 if(!open($file, ">$filename")) {
2369 $self->throw_exception("Can't open $filename for writing ($!)");
2372 print $file $output;
2375 next unless ($preversion);
2377 require SQL::Translator::Diff;
2379 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2380 if(!-e $prefilename) {
2381 carp("No previous schema file found ($prefilename)");
2385 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2387 carp("Overwriting existing diff file - $difffile");
2393 my $t = SQL::Translator->new($sqltargs);
2398 or $self->throw_exception ($t->error);
2400 my $out = $t->translate( $prefilename )
2401 or $self->throw_exception ($t->error);
2403 $source_schema = $t->schema;
2405 $source_schema->name( $prefilename )
2406 unless ( $source_schema->name );
2409 # The "new" style of producers have sane normalization and can support
2410 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2411 # And we have to diff parsed SQL against parsed SQL.
2412 my $dest_schema = $sqlt_schema;
2414 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2415 my $t = SQL::Translator->new($sqltargs);
2420 or $self->throw_exception ($t->error);
2422 my $out = $t->translate( $filename )
2423 or $self->throw_exception ($t->error);
2425 $dest_schema = $t->schema;
2427 $dest_schema->name( $filename )
2428 unless $dest_schema->name;
2431 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2435 if(!open $file, ">$difffile") {
2436 $self->throw_exception("Can't write to $difffile ($!)");
2444 =head2 deployment_statements
2448 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2452 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2454 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2455 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2457 C<$directory> is used to return statements from files in a previously created
2458 L</create_ddl_dir> directory and is optional. The filenames are constructed
2459 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2461 If no C<$directory> is specified then the statements are constructed on the
2462 fly using L<SQL::Translator> and C<$version> is ignored.
2464 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2468 sub deployment_statements {
2469 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2470 $type ||= $self->sqlt_type;
2471 $version ||= $schema->schema_version || '1.x';
2473 my $filename = $schema->ddl_filename($type, $version, $dir);
2477 open($file, "<$filename")
2478 or $self->throw_exception("Can't open $filename ($!)");
2481 return join('', @rows);
2484 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2485 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2488 # sources needs to be a parser arg, but for simplicty allow at top level
2490 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2491 if exists $sqltargs->{sources};
2493 my $tr = SQL::Translator->new(
2494 producer => "SQL::Translator::Producer::${type}",
2496 parser => 'SQL::Translator::Parser::DBIx::Class',
2503 @ret = $tr->translate;
2506 $ret[0] = $tr->translate;
2509 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2510 unless (@ret && defined $ret[0]);
2512 return $wa ? @ret : $ret[0];
2516 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2519 return if($line =~ /^--/);
2521 # next if($line =~ /^DROP/m);
2522 return if($line =~ /^BEGIN TRANSACTION/m);
2523 return if($line =~ /^COMMIT/m);
2524 return if $line =~ /^\s+$/; # skip whitespace only
2525 $self->_query_start($line);
2527 # do a dbh_do cycle here, as we need some error checking in
2528 # place (even though we will ignore errors)
2529 $self->dbh_do (sub { $_[1]->do($line) });
2532 carp qq{$@ (running "${line}")};
2534 $self->_query_end($line);
2536 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2537 if (@statements > 1) {
2538 foreach my $statement (@statements) {
2539 $deploy->( $statement );
2542 elsif (@statements == 1) {
2543 foreach my $line ( split(";\n", $statements[0])) {
2549 =head2 datetime_parser
2551 Returns the datetime parser class
2555 sub datetime_parser {
2557 return $self->{datetime_parser} ||= do {
2558 $self->build_datetime_parser(@_);
2562 =head2 datetime_parser_type
2564 Defines (returns) the datetime parser class - currently hardwired to
2565 L<DateTime::Format::MySQL>
2569 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2571 =head2 build_datetime_parser
2573 See L</datetime_parser>
2577 sub build_datetime_parser {
2579 my $type = $self->datetime_parser_type(@_);
2580 $self->ensure_class_loaded ($type);
2585 =head2 is_replicating
2587 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2588 replicate from a master database. Default is undef, which is the result
2589 returned by databases that don't support replication.
2593 sub is_replicating {
2598 =head2 lag_behind_master
2600 Returns a number that represents a certain amount of lag behind a master db
2601 when a given storage is replicating. The number is database dependent, but
2602 starts at zero and increases with the amount of lag. Default in undef
2606 sub lag_behind_master {
2610 =head2 relname_to_table_alias
2614 =item Arguments: $relname, $join_count
2618 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2621 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2622 way these aliases are named.
2624 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2625 otherwise C<"$relname">.
2629 sub relname_to_table_alias {
2630 my ($self, $relname, $join_count) = @_;
2632 my $alias = ($join_count && $join_count > 1 ?
2633 join('_', $relname, $join_count) : $relname);
2642 =head2 DBIx::Class and AutoCommit
2644 DBIx::Class can do some wonderful magic with handling exceptions,
2645 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2646 (the default) combined with C<txn_do> for transaction support.
2648 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2649 in an assumed transaction between commits, and you're telling us you'd
2650 like to manage that manually. A lot of the magic protections offered by
2651 this module will go away. We can't protect you from exceptions due to database
2652 disconnects because we don't know anything about how to restart your
2653 transactions. You're on your own for handling all sorts of exceptional
2654 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2660 Matt S. Trout <mst@shadowcatsystems.co.uk>
2662 Andy Grundman <andy@hybridized.org>
2666 You may distribute this code under the same terms as Perl itself.