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;
784 @result = $coderef->(@_);
786 elsif(defined $want_array) {
787 $result[0] = $coderef->(@_);
795 # ->connected might unset $@ - copy
797 if(!$exception) { return $want_array ? @result : $result[0] }
799 if($tried++ || $self->connected) {
800 eval { $self->txn_rollback };
801 my $rollback_exception = $@;
802 if($rollback_exception) {
803 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
804 $self->throw_exception($exception) # propagate nested rollback
805 if $rollback_exception =~ /$exception_class/;
807 $self->throw_exception(
808 "Transaction aborted: ${exception}. "
809 . "Rollback failed: ${rollback_exception}"
812 $self->throw_exception($exception)
815 # We were not connected, and was first try - reconnect and retry
817 carp "Retrying $coderef after catching disconnected exception: $exception"
818 if $ENV{DBIC_DBIRETRY_DEBUG};
819 $self->_populate_dbh;
825 Our C<disconnect> method also performs a rollback first if the
826 database is not in C<AutoCommit> mode.
836 push @actions, ( $self->on_disconnect_call || () );
837 push @actions, $self->_parse_connect_do ('on_disconnect_do');
839 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
841 $self->_dbh_rollback unless $self->_dbh_autocommit;
843 %{ $self->_dbh->{CachedKids} } = ();
844 $self->_dbh->disconnect;
850 =head2 with_deferred_fk_checks
854 =item Arguments: C<$coderef>
856 =item Return Value: The return value of $coderef
860 Storage specific method to run the code ref with FK checks deferred or
861 in MySQL's case disabled entirely.
865 # Storage subclasses should override this
866 sub with_deferred_fk_checks {
867 my ($self, $sub) = @_;
875 =item Arguments: none
877 =item Return Value: 1|0
881 Verifies that the current database handle is active and ready to execute
882 an SQL statement (e.g. the connection did not get stale, server is still
883 answering, etc.) This method is used internally by L</dbh>.
889 return 0 unless $self->_seems_connected;
892 local $self->_dbh->{RaiseError} = 1;
897 sub _seems_connected {
900 $self->_preserve_foreign_dbh;
902 my $dbh = $self->_dbh
905 return $dbh->FETCH('Active');
911 my $dbh = $self->_dbh or return 0;
916 sub ensure_connected {
919 unless ($self->connected) {
920 $self->_populate_dbh;
926 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
927 is guaranteed to be healthy by implicitly calling L</connected>, and if
928 necessary performing a reconnection before returning. Keep in mind that this
929 is very B<expensive> on some database engines. Consider using L</dbh_do>
937 if (not $self->_dbh) {
938 $self->_populate_dbh;
940 $self->ensure_connected;
945 # this is the internal "get dbh or connect (don't check)" method
948 $self->_preserve_foreign_dbh;
949 $self->_populate_dbh unless $self->_dbh;
953 sub _sql_maker_args {
958 array_datatypes => 1,
959 limit_dialect => $self->_get_dbh,
960 %{$self->_sql_maker_opts}
966 unless ($self->_sql_maker) {
967 my $sql_maker_class = $self->sql_maker_class;
968 $self->ensure_class_loaded ($sql_maker_class);
969 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
971 return $self->_sql_maker;
974 # nothing to do by default
981 my @info = @{$self->_dbi_connect_info || []};
982 $self->_dbh(undef); # in case ->connected failed we might get sent here
983 $self->_server_info_hash (undef);
984 $self->_dbh($self->_connect(@info));
986 $self->_conn_pid($$);
987 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
989 $self->_determine_driver;
991 # Always set the transaction depth on connect, since
992 # there is no transaction in progress by definition
993 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
995 $self->_run_connection_actions unless $self->{_in_determine_driver};
998 sub _run_connection_actions {
1002 push @actions, ( $self->on_connect_call || () );
1003 push @actions, $self->_parse_connect_do ('on_connect_do');
1005 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1011 unless ($self->_server_info_hash) {
1015 my $server_version = do {
1016 local $@; # might be happenin in some sort of destructor
1017 try { $self->_get_server_version };
1020 if (defined $server_version) {
1021 $info{dbms_version} = $server_version;
1023 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1024 my @verparts = split (/\./, $numeric_version);
1030 # consider only up to 3 version parts, iff not more than 3 digits
1032 while (@verparts && @use_parts < 3) {
1033 my $p = shift @verparts;
1035 push @use_parts, $p;
1037 push @use_parts, 0 while @use_parts < 3;
1039 $info{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1043 $self->_server_info_hash(\%info);
1046 return $self->_server_info_hash
1049 sub _get_server_version {
1050 shift->_get_dbh->get_info(18);
1053 sub _determine_driver {
1056 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1057 my $started_connected = 0;
1058 local $self->{_in_determine_driver} = 1;
1060 if (ref($self) eq __PACKAGE__) {
1062 if ($self->_dbh) { # we are connected
1063 $driver = $self->_dbh->{Driver}{Name};
1064 $started_connected = 1;
1066 # if connect_info is a CODEREF, we have no choice but to connect
1067 if (ref $self->_dbi_connect_info->[0] &&
1068 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
1069 $self->_populate_dbh;
1070 $driver = $self->_dbh->{Driver}{Name};
1073 # try to use dsn to not require being connected, the driver may still
1074 # force a connection in _rebless to determine version
1075 # (dsn may not be supplied at all if all we do is make a mock-schema)
1076 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1077 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1078 $driver ||= $ENV{DBI_DRIVER};
1083 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1084 if ($self->load_optional_class($storage_class)) {
1085 mro::set_mro($storage_class, 'c3');
1086 bless $self, $storage_class;
1092 $self->_driver_determined(1);
1094 $self->_init; # run driver-specific initializations
1096 $self->_run_connection_actions
1097 if !$started_connected && defined $self->_dbh;
1101 sub _do_connection_actions {
1103 my $method_prefix = shift;
1106 if (not ref($call)) {
1107 my $method = $method_prefix . $call;
1109 } elsif (ref($call) eq 'CODE') {
1111 } elsif (ref($call) eq 'ARRAY') {
1112 if (ref($call->[0]) ne 'ARRAY') {
1113 $self->_do_connection_actions($method_prefix, $_) for @$call;
1115 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1118 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1124 sub connect_call_do_sql {
1126 $self->_do_query(@_);
1129 sub disconnect_call_do_sql {
1131 $self->_do_query(@_);
1134 # override in db-specific backend when necessary
1135 sub connect_call_datetime_setup { 1 }
1138 my ($self, $action) = @_;
1140 if (ref $action eq 'CODE') {
1141 $action = $action->($self);
1142 $self->_do_query($_) foreach @$action;
1145 # Most debuggers expect ($sql, @bind), so we need to exclude
1146 # the attribute hash which is the second argument to $dbh->do
1147 # furthermore the bind values are usually to be presented
1148 # as named arrayref pairs, so wrap those here too
1149 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1150 my $sql = shift @do_args;
1151 my $attrs = shift @do_args;
1152 my @bind = map { [ undef, $_ ] } @do_args;
1154 $self->_query_start($sql, @bind);
1155 $self->_get_dbh->do($sql, $attrs, @do_args);
1156 $self->_query_end($sql, @bind);
1163 my ($self, @info) = @_;
1165 $self->throw_exception("You failed to provide any connection info")
1168 my ($old_connect_via, $dbh);
1170 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1171 $old_connect_via = $DBI::connect_via;
1172 $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;
1205 $DBI::connect_via = $old_connect_via if $old_connect_via;
1207 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1208 if !$dbh || $caught;
1210 $self->_dbh_autocommit($dbh->{AutoCommit});
1216 my ($self, $name) = @_;
1218 $name = $self->_svp_generate_name
1219 unless defined $name;
1221 $self->throw_exception ("You can't use savepoints outside a transaction")
1222 if $self->{transaction_depth} == 0;
1224 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1225 unless $self->can('_svp_begin');
1227 push @{ $self->{savepoints} }, $name;
1229 $self->debugobj->svp_begin($name) if $self->debug;
1231 return $self->_svp_begin($name);
1235 my ($self, $name) = @_;
1237 $self->throw_exception ("You can't use savepoints outside a transaction")
1238 if $self->{transaction_depth} == 0;
1240 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1241 unless $self->can('_svp_release');
1243 if (defined $name) {
1244 $self->throw_exception ("Savepoint '$name' does not exist")
1245 unless grep { $_ eq $name } @{ $self->{savepoints} };
1247 # Dig through the stack until we find the one we are releasing. This keeps
1248 # the stack up to date.
1251 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1253 $name = pop @{ $self->{savepoints} };
1256 $self->debugobj->svp_release($name) if $self->debug;
1258 return $self->_svp_release($name);
1262 my ($self, $name) = @_;
1264 $self->throw_exception ("You can't use savepoints outside a transaction")
1265 if $self->{transaction_depth} == 0;
1267 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1268 unless $self->can('_svp_rollback');
1270 if (defined $name) {
1271 # If they passed us a name, verify that it exists in the stack
1272 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1273 $self->throw_exception("Savepoint '$name' does not exist!");
1276 # Dig through the stack until we find the one we are releasing. This keeps
1277 # the stack up to date.
1278 while(my $s = pop(@{ $self->{savepoints} })) {
1279 last if($s eq $name);
1281 # Add the savepoint back to the stack, as a rollback doesn't remove the
1282 # named savepoint, only everything after it.
1283 push(@{ $self->{savepoints} }, $name);
1285 # We'll assume they want to rollback to the last savepoint
1286 $name = $self->{savepoints}->[-1];
1289 $self->debugobj->svp_rollback($name) if $self->debug;
1291 return $self->_svp_rollback($name);
1294 sub _svp_generate_name {
1297 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1303 # this means we have not yet connected and do not know the AC status
1304 # (e.g. coderef $dbh)
1305 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1307 if($self->{transaction_depth} == 0) {
1308 $self->debugobj->txn_begin()
1310 $self->_dbh_begin_work;
1312 elsif ($self->auto_savepoint) {
1315 $self->{transaction_depth}++;
1318 sub _dbh_begin_work {
1321 # if the user is utilizing txn_do - good for him, otherwise we need to
1322 # ensure that the $dbh is healthy on BEGIN.
1323 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1324 # will be replaced by a failure of begin_work itself (which will be
1325 # then retried on reconnect)
1326 if ($self->{_in_dbh_do}) {
1327 $self->_dbh->begin_work;
1329 $self->dbh_do(sub { $_[1]->begin_work });
1335 if ($self->{transaction_depth} == 1) {
1336 $self->debugobj->txn_commit()
1339 $self->{transaction_depth} = 0
1340 if $self->_dbh_autocommit;
1342 elsif($self->{transaction_depth} > 1) {
1343 $self->{transaction_depth}--;
1345 if $self->auto_savepoint;
1351 my $dbh = $self->_dbh
1352 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1358 my $dbh = $self->_dbh;
1360 if ($self->{transaction_depth} == 1) {
1361 $self->debugobj->txn_rollback()
1363 $self->{transaction_depth} = 0
1364 if $self->_dbh_autocommit;
1365 $self->_dbh_rollback;
1367 elsif($self->{transaction_depth} > 1) {
1368 $self->{transaction_depth}--;
1369 if ($self->auto_savepoint) {
1370 $self->svp_rollback;
1375 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1380 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1381 $error =~ /$exception_class/ and $self->throw_exception($error);
1382 # ensure that a failed rollback resets the transaction depth
1383 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1384 $self->throw_exception($error);
1390 my $dbh = $self->_dbh
1391 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1395 # This used to be the top-half of _execute. It was split out to make it
1396 # easier to override in NoBindVars without duping the rest. It takes up
1397 # all of _execute's args, and emits $sql, @bind.
1398 sub _prep_for_execute {
1399 my ($self, $op, $extra_bind, $ident, $args) = @_;
1401 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1402 $ident = $ident->from();
1405 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1408 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1410 return ($sql, \@bind);
1414 sub _fix_bind_params {
1415 my ($self, @bind) = @_;
1417 ### Turn @bind from something like this:
1418 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1420 ### ( "'1'", "'1'", "'3'" )
1423 if ( defined( $_ && $_->[1] ) ) {
1424 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1431 my ( $self, $sql, @bind ) = @_;
1433 if ( $self->debug ) {
1434 @bind = $self->_fix_bind_params(@bind);
1436 $self->debugobj->query_start( $sql, @bind );
1441 my ( $self, $sql, @bind ) = @_;
1443 if ( $self->debug ) {
1444 @bind = $self->_fix_bind_params(@bind);
1445 $self->debugobj->query_end( $sql, @bind );
1450 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1452 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1454 $self->_query_start( $sql, @$bind );
1456 my $sth = $self->sth($sql,$op);
1458 my $placeholder_index = 1;
1460 foreach my $bound (@$bind) {
1461 my $attributes = {};
1462 my($column_name, @data) = @$bound;
1464 if ($bind_attributes) {
1465 $attributes = $bind_attributes->{$column_name}
1466 if defined $bind_attributes->{$column_name};
1469 foreach my $data (@data) {
1470 my $ref = ref $data;
1471 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1473 $sth->bind_param($placeholder_index, $data, $attributes);
1474 $placeholder_index++;
1478 # Can this fail without throwing an exception anyways???
1479 my $rv = $sth->execute();
1480 $self->throw_exception($sth->errstr) if !$rv;
1482 $self->_query_end( $sql, @$bind );
1484 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1489 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1492 sub _prefetch_insert_auto_nextvals {
1493 my ($self, $source, $to_insert) = @_;
1497 foreach my $col ( $source->columns ) {
1498 if ( !defined $to_insert->{$col} ) {
1499 my $col_info = $source->column_info($col);
1501 if ( $col_info->{auto_nextval} ) {
1502 $upd->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1504 $col_info->{sequence} ||=
1505 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1516 my ($source, $to_insert, $opts) = @_;
1518 my $updated_cols = $self->_prefetch_insert_auto_nextvals (@_);
1520 my $bind_attributes = $self->source_bind_attributes($source);
1522 my ($rv, $sth) = $self->_execute('insert' => [], $source, $bind_attributes, $to_insert, $opts);
1524 if ($opts->{returning}) {
1525 my @ret_cols = @{$opts->{returning}};
1527 my @ret_vals = eval {
1528 local $SIG{__WARN__} = sub {};
1529 my @r = $sth->fetchrow_array;
1535 @ret{@ret_cols} = @ret_vals if (@ret_vals);
1543 return $updated_cols;
1546 ## Currently it is assumed that all values passed will be "normal", i.e. not
1547 ## scalar refs, or at least, all the same type as the first set, the statement is
1548 ## only prepped once.
1550 my ($self, $source, $cols, $data) = @_;
1553 @colvalues{@$cols} = (0..$#$cols);
1555 for my $i (0..$#$cols) {
1556 my $first_val = $data->[0][$i];
1557 next unless ref $first_val eq 'SCALAR';
1559 $colvalues{ $cols->[$i] } = $first_val;
1562 # check for bad data and stringify stringifiable objects
1563 my $bad_slice = sub {
1564 my ($msg, $col_idx, $slice_idx) = @_;
1565 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1569 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1570 Data::Dumper::Concise::Dumper({
1571 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1577 for my $datum_idx (0..$#$data) {
1578 my $datum = $data->[$datum_idx];
1580 for my $col_idx (0..$#$cols) {
1581 my $val = $datum->[$col_idx];
1582 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1583 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1585 if ($is_literal_sql) {
1587 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1589 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1590 $bad_slice->("$reftype reference found where literal SQL expected",
1591 $col_idx, $datum_idx);
1593 elsif ($$val ne $$sqla_bind){
1594 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1595 $col_idx, $datum_idx);
1598 elsif (my $reftype = ref $val) {
1600 if (overload::Method($val, '""')) {
1601 $datum->[$col_idx] = "".$val;
1604 $bad_slice->("$reftype reference found where bind expected",
1605 $col_idx, $datum_idx);
1611 my ($sql, $bind) = $self->_prep_for_execute (
1612 'insert', undef, $source, [\%colvalues]
1616 my $empty_bind = 1 if (not @bind) &&
1617 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1619 if ((not @bind) && (not $empty_bind)) {
1620 $self->throw_exception(
1621 'Cannot insert_bulk without support for placeholders'
1625 # neither _execute_array, nor _execute_inserts_with_no_binds are
1626 # atomic (even if _execute _array is a single call). Thus a safety
1628 my $guard = $self->txn_scope_guard;
1630 $self->_query_start( $sql, ['__BULK__'] );
1631 my $sth = $self->sth($sql);
1634 # bind_param_array doesn't work if there are no binds
1635 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1638 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1639 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1643 $self->_query_end( $sql, ['__BULK__'] );
1647 return (wantarray ? ($rv, $sth, @bind) : $rv);
1650 sub _execute_array {
1651 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1653 ## This must be an arrayref, else nothing works!
1654 my $tuple_status = [];
1656 ## Get the bind_attributes, if any exist
1657 my $bind_attributes = $self->source_bind_attributes($source);
1659 ## Bind the values and execute
1660 my $placeholder_index = 1;
1662 foreach my $bound (@$bind) {
1664 my $attributes = {};
1665 my ($column_name, $data_index) = @$bound;
1667 if( $bind_attributes ) {
1668 $attributes = $bind_attributes->{$column_name}
1669 if defined $bind_attributes->{$column_name};
1672 my @data = map { $_->[$data_index] } @$data;
1674 $sth->bind_param_array(
1677 (%$attributes ? $attributes : ()),
1679 $placeholder_index++;
1683 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1685 my $err = $@ || $sth->errstr;
1687 # Statement must finish even if there was an exception.
1688 eval { $sth->finish };
1689 $err = $@ unless $err;
1693 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1695 $self->throw_exception("Unexpected populate error: $err")
1696 if ($i > $#$tuple_status);
1698 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1699 ($tuple_status->[$i][1] || $err),
1700 Data::Dumper::Concise::Dumper({
1701 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1708 sub _dbh_execute_array {
1709 my ($self, $sth, $tuple_status, @extra) = @_;
1711 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1714 sub _dbh_execute_inserts_with_no_binds {
1715 my ($self, $sth, $count) = @_;
1718 my $dbh = $self->_get_dbh;
1719 local $dbh->{RaiseError} = 1;
1720 local $dbh->{PrintError} = 0;
1722 $sth->execute foreach 1..$count;
1726 # Make sure statement is finished even if there was an exception.
1727 eval { $sth->finish };
1728 $exception = $@ unless $exception;
1730 $self->throw_exception($exception) if $exception;
1736 my ($self, $source, @args) = @_;
1738 my $bind_attrs = $self->source_bind_attributes($source);
1740 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1745 my ($self, $source, @args) = @_;
1747 my $bind_attrs = $self->source_bind_attributes($source);
1749 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1752 # We were sent here because the $rs contains a complex search
1753 # which will require a subquery to select the correct rows
1754 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1756 # Generating a single PK column subquery is trivial and supported
1757 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1758 # Look at _multipk_update_delete()
1759 sub _subq_update_delete {
1761 my ($rs, $op, $values) = @_;
1763 my $rsrc = $rs->result_source;
1765 # quick check if we got a sane rs on our hands
1766 my @pcols = $rsrc->_pri_cols;
1768 my $sel = $rs->_resolved_attrs->{select};
1769 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1772 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1774 join ("\x00", sort @$sel )
1776 $self->throw_exception (
1777 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1784 $op eq 'update' ? $values : (),
1785 { $pcols[0] => { -in => $rs->as_query } },
1790 return $self->_multipk_update_delete (@_);
1794 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1795 # resultset update/delete involving subqueries. So by default resort
1796 # to simple (and inefficient) delete_all style per-row opearations,
1797 # while allowing specific storages to override this with a faster
1800 sub _multipk_update_delete {
1801 return shift->_per_row_update_delete (@_);
1804 # This is the default loop used to delete/update rows for multi PK
1805 # resultsets, and used by mysql exclusively (because it can't do anything
1808 # We do not use $row->$op style queries, because resultset update/delete
1809 # is not expected to cascade (this is what delete_all/update_all is for).
1811 # There should be no race conditions as the entire operation is rolled
1814 sub _per_row_update_delete {
1816 my ($rs, $op, $values) = @_;
1818 my $rsrc = $rs->result_source;
1819 my @pcols = $rsrc->_pri_cols;
1821 my $guard = $self->txn_scope_guard;
1823 # emulate the return value of $sth->execute for non-selects
1824 my $row_cnt = '0E0';
1826 my $subrs_cur = $rs->cursor;
1827 my @all_pk = $subrs_cur->all;
1828 for my $pks ( @all_pk) {
1831 for my $i (0.. $#pcols) {
1832 $cond->{$pcols[$i]} = $pks->[$i];
1837 $op eq 'update' ? $values : (),
1851 $self->_execute($self->_select_args(@_));
1854 sub _select_args_to_query {
1857 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $rs_attrs, $rows, $offset)
1858 # = $self->_select_args($ident, $select, $cond, $attrs);
1859 my ($op, $bind, $ident, $bind_attrs, @args) =
1860 $self->_select_args(@_);
1862 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
1863 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1864 $prepared_bind ||= [];
1867 ? ($sql, $prepared_bind, $bind_attrs)
1868 : \[ "($sql)", @$prepared_bind ]
1873 my ($self, $ident, $select, $where, $attrs) = @_;
1875 my $sql_maker = $self->sql_maker;
1876 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1883 $rs_alias && $alias2source->{$rs_alias}
1884 ? ( _rsroot_source_handle => $alias2source->{$rs_alias}->handle )
1889 # calculate bind_attrs before possible $ident mangling
1890 my $bind_attrs = {};
1891 for my $alias (keys %$alias2source) {
1892 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1893 for my $col (keys %$bindtypes) {
1895 my $fqcn = join ('.', $alias, $col);
1896 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1898 # Unqialified column names are nice, but at the same time can be
1899 # rather ambiguous. What we do here is basically go along with
1900 # the loop, adding an unqualified column slot to $bind_attrs,
1901 # alongside the fully qualified name. As soon as we encounter
1902 # another column by that name (which would imply another table)
1903 # we unset the unqualified slot and never add any info to it
1904 # to avoid erroneous type binding. If this happens the users
1905 # only choice will be to fully qualify his column name
1907 if (exists $bind_attrs->{$col}) {
1908 $bind_attrs->{$col} = {};
1911 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1918 $attrs->{software_limit}
1920 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1922 $attrs->{software_limit} = 1;
1925 $self->throw_exception("rows attribute must be positive if present")
1926 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1928 # MySQL actually recommends this approach. I cringe.
1929 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1934 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1935 # storage, unless software limit was requested
1938 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1940 # grouped prefetch (to satisfy group_by == select)
1941 ( $attrs->{group_by}
1943 @{$attrs->{group_by}}
1945 $attrs->{_prefetch_select}
1947 @{$attrs->{_prefetch_select}}
1950 ($ident, $select, $where, $attrs)
1951 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1953 elsif (! $attrs->{software_limit} ) {
1954 push @limit, $attrs->{rows}, $attrs->{offset};
1957 # try to simplify the joinmap further (prune unreferenced type-single joins)
1958 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1961 # This would be the point to deflate anything found in $where
1962 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1963 # expect a row object. And all we have is a resultsource (it is trivial
1964 # to extract deflator coderefs via $alias2source above).
1966 # I don't see a way forward other than changing the way deflators are
1967 # invoked, and that's just bad...
1970 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $attrs, @limit);
1973 # Returns a counting SELECT for a simple count
1974 # query. Abstracted so that a storage could override
1975 # this to { count => 'firstcol' } or whatever makes
1976 # sense as a performance optimization
1978 #my ($self, $source, $rs_attrs) = @_;
1979 return { count => '*' };
1983 sub source_bind_attributes {
1984 my ($self, $source) = @_;
1986 my $bind_attributes;
1987 foreach my $column ($source->columns) {
1989 my $data_type = $source->column_info($column)->{data_type} || '';
1990 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1994 return $bind_attributes;
2001 =item Arguments: $ident, $select, $condition, $attrs
2005 Handle a SQL select statement.
2011 my ($ident, $select, $condition, $attrs) = @_;
2012 return $self->cursor_class->new($self, \@_, $attrs);
2017 my ($rv, $sth, @bind) = $self->_select(@_);
2018 my @row = $sth->fetchrow_array;
2019 my @nextrow = $sth->fetchrow_array if @row;
2020 if(@row && @nextrow) {
2021 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2023 # Need to call finish() to work round broken DBDs
2032 =item Arguments: $sql
2036 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2041 my ($self, $dbh, $sql) = @_;
2043 # 3 is the if_active parameter which avoids active sth re-use
2044 my $sth = $self->disable_sth_caching
2045 ? $dbh->prepare($sql)
2046 : $dbh->prepare_cached($sql, {}, 3);
2048 # XXX You would think RaiseError would make this impossible,
2049 # but apparently that's not true :(
2050 $self->throw_exception($dbh->errstr) if !$sth;
2056 my ($self, $sql) = @_;
2057 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2060 sub _dbh_columns_info_for {
2061 my ($self, $dbh, $table) = @_;
2063 if ($dbh->can('column_info')) {
2066 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2067 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2069 while ( my $info = $sth->fetchrow_hashref() ){
2071 $column_info{data_type} = $info->{TYPE_NAME};
2072 $column_info{size} = $info->{COLUMN_SIZE};
2073 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2074 $column_info{default_value} = $info->{COLUMN_DEF};
2075 my $col_name = $info->{COLUMN_NAME};
2076 $col_name =~ s/^\"(.*)\"$/$1/;
2078 $result{$col_name} = \%column_info;
2081 return \%result if !$@ && scalar keys %result;
2085 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2087 my @columns = @{$sth->{NAME_lc}};
2088 for my $i ( 0 .. $#columns ){
2090 $column_info{data_type} = $sth->{TYPE}->[$i];
2091 $column_info{size} = $sth->{PRECISION}->[$i];
2092 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2094 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2095 $column_info{data_type} = $1;
2096 $column_info{size} = $2;
2099 $result{$columns[$i]} = \%column_info;
2103 foreach my $col (keys %result) {
2104 my $colinfo = $result{$col};
2105 my $type_num = $colinfo->{data_type};
2107 if(defined $type_num && $dbh->can('type_info')) {
2108 my $type_info = $dbh->type_info($type_num);
2109 $type_name = $type_info->{TYPE_NAME} if $type_info;
2110 $colinfo->{data_type} = $type_name if $type_name;
2117 sub columns_info_for {
2118 my ($self, $table) = @_;
2119 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2122 =head2 last_insert_id
2124 Return the row id of the last insert.
2128 sub _dbh_last_insert_id {
2129 my ($self, $dbh, $source, $col) = @_;
2131 my $id = eval { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2133 return $id if defined $id;
2135 my $class = ref $self;
2136 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2139 sub last_insert_id {
2141 $self->_dbh_last_insert_id ($self->_dbh, @_);
2144 =head2 _native_data_type
2148 =item Arguments: $type_name
2152 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2153 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2154 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2156 The default implementation returns C<undef>, implement in your Storage driver if
2157 you need this functionality.
2159 Should map types from other databases to the native RDBMS type, for example
2160 C<VARCHAR2> to C<VARCHAR>.
2162 Types with modifiers should map to the underlying data type. For example,
2163 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2165 Composite types should map to the container type, for example
2166 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2170 sub _native_data_type {
2171 #my ($self, $data_type) = @_;
2175 # Check if placeholders are supported at all
2176 sub _placeholders_supported {
2178 my $dbh = $self->_get_dbh;
2180 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2181 # but it is inaccurate more often than not
2183 local $dbh->{PrintError} = 0;
2184 local $dbh->{RaiseError} = 1;
2185 $dbh->do('select ?', {}, 1);
2190 # Check if placeholders bound to non-string types throw exceptions
2192 sub _typeless_placeholders_supported {
2194 my $dbh = $self->_get_dbh;
2197 local $dbh->{PrintError} = 0;
2198 local $dbh->{RaiseError} = 1;
2199 # this specifically tests a bind that is NOT a string
2200 $dbh->do('select 1 where 1 = ?', {}, 1);
2207 Returns the database driver name.
2212 shift->_get_dbh->{Driver}->{Name};
2215 =head2 bind_attribute_by_data_type
2217 Given a datatype from column info, returns a database specific bind
2218 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2219 let the database planner just handle it.
2221 Generally only needed for special case column types, like bytea in postgres.
2225 sub bind_attribute_by_data_type {
2229 =head2 is_datatype_numeric
2231 Given a datatype from column_info, returns a boolean value indicating if
2232 the current RDBMS considers it a numeric value. This controls how
2233 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2234 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2235 be performed instead of the usual C<eq>.
2239 sub is_datatype_numeric {
2240 my ($self, $dt) = @_;
2242 return 0 unless $dt;
2244 return $dt =~ /^ (?:
2245 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2250 =head2 create_ddl_dir
2254 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2258 Creates a SQL file based on the Schema, for each of the specified
2259 database engines in C<\@databases> in the given directory.
2260 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2262 Given a previous version number, this will also create a file containing
2263 the ALTER TABLE statements to transform the previous schema into the
2264 current one. Note that these statements may contain C<DROP TABLE> or
2265 C<DROP COLUMN> statements that can potentially destroy data.
2267 The file names are created using the C<ddl_filename> method below, please
2268 override this method in your schema if you would like a different file
2269 name format. For the ALTER file, the same format is used, replacing
2270 $version in the name with "$preversion-$version".
2272 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2273 The most common value for this would be C<< { add_drop_table => 1 } >>
2274 to have the SQL produced include a C<DROP TABLE> statement for each table
2275 created. For quoting purposes supply C<quote_table_names> and
2276 C<quote_field_names>.
2278 If no arguments are passed, then the following default values are assumed:
2282 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2284 =item version - $schema->schema_version
2286 =item directory - './'
2288 =item preversion - <none>
2292 By default, C<\%sqlt_args> will have
2294 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2296 merged with the hash passed in. To disable any of those features, pass in a
2297 hashref like the following
2299 { ignore_constraint_names => 0, # ... other options }
2302 WARNING: You are strongly advised to check all SQL files created, before applying
2307 sub create_ddl_dir {
2308 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2311 carp "No directory given, using ./\n";
2314 -d $dir or File::Path::mkpath($dir)
2315 or $self->throw_exception("create_ddl_dir: $! creating dir '$dir'");
2318 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2320 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2321 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2323 my $schema_version = $schema->schema_version || '1.x';
2324 $version ||= $schema_version;
2327 add_drop_table => 1,
2328 ignore_constraint_names => 1,
2329 ignore_index_names => 1,
2333 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2334 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2337 my $sqlt = SQL::Translator->new( $sqltargs );
2339 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2340 my $sqlt_schema = $sqlt->translate({ data => $schema })
2341 or $self->throw_exception ($sqlt->error);
2343 foreach my $db (@$databases) {
2345 $sqlt->{schema} = $sqlt_schema;
2346 $sqlt->producer($db);
2349 my $filename = $schema->ddl_filename($db, $version, $dir);
2350 if (-e $filename && ($version eq $schema_version )) {
2351 # if we are dumping the current version, overwrite the DDL
2352 carp "Overwriting existing DDL file - $filename";
2356 my $output = $sqlt->translate;
2358 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2361 if(!open($file, ">$filename")) {
2362 $self->throw_exception("Can't open $filename for writing ($!)");
2365 print $file $output;
2368 next unless ($preversion);
2370 require SQL::Translator::Diff;
2372 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2373 if(!-e $prefilename) {
2374 carp("No previous schema file found ($prefilename)");
2378 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2380 carp("Overwriting existing diff file - $difffile");
2386 my $t = SQL::Translator->new($sqltargs);
2391 or $self->throw_exception ($t->error);
2393 my $out = $t->translate( $prefilename )
2394 or $self->throw_exception ($t->error);
2396 $source_schema = $t->schema;
2398 $source_schema->name( $prefilename )
2399 unless ( $source_schema->name );
2402 # The "new" style of producers have sane normalization and can support
2403 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2404 # And we have to diff parsed SQL against parsed SQL.
2405 my $dest_schema = $sqlt_schema;
2407 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2408 my $t = SQL::Translator->new($sqltargs);
2413 or $self->throw_exception ($t->error);
2415 my $out = $t->translate( $filename )
2416 or $self->throw_exception ($t->error);
2418 $dest_schema = $t->schema;
2420 $dest_schema->name( $filename )
2421 unless $dest_schema->name;
2424 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2428 if(!open $file, ">$difffile") {
2429 $self->throw_exception("Can't write to $difffile ($!)");
2437 =head2 deployment_statements
2441 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2445 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2447 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2448 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2450 C<$directory> is used to return statements from files in a previously created
2451 L</create_ddl_dir> directory and is optional. The filenames are constructed
2452 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2454 If no C<$directory> is specified then the statements are constructed on the
2455 fly using L<SQL::Translator> and C<$version> is ignored.
2457 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2461 sub deployment_statements {
2462 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2463 $type ||= $self->sqlt_type;
2464 $version ||= $schema->schema_version || '1.x';
2466 my $filename = $schema->ddl_filename($type, $version, $dir);
2470 open($file, "<$filename")
2471 or $self->throw_exception("Can't open $filename ($!)");
2474 return join('', @rows);
2477 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2478 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2481 # sources needs to be a parser arg, but for simplicty allow at top level
2483 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2484 if exists $sqltargs->{sources};
2486 my $tr = SQL::Translator->new(
2487 producer => "SQL::Translator::Producer::${type}",
2489 parser => 'SQL::Translator::Parser::DBIx::Class',
2496 @ret = $tr->translate;
2499 $ret[0] = $tr->translate;
2502 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2503 unless (@ret && defined $ret[0]);
2505 return $wa ? @ret : $ret[0];
2509 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2512 return if($line =~ /^--/);
2514 # next if($line =~ /^DROP/m);
2515 return if($line =~ /^BEGIN TRANSACTION/m);
2516 return if($line =~ /^COMMIT/m);
2517 return if $line =~ /^\s+$/; # skip whitespace only
2518 $self->_query_start($line);
2520 # do a dbh_do cycle here, as we need some error checking in
2521 # place (even though we will ignore errors)
2522 $self->dbh_do (sub { $_[1]->do($line) });
2525 carp qq{$@ (running "${line}")};
2527 $self->_query_end($line);
2529 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2530 if (@statements > 1) {
2531 foreach my $statement (@statements) {
2532 $deploy->( $statement );
2535 elsif (@statements == 1) {
2536 foreach my $line ( split(";\n", $statements[0])) {
2542 =head2 datetime_parser
2544 Returns the datetime parser class
2548 sub datetime_parser {
2550 return $self->{datetime_parser} ||= do {
2551 $self->build_datetime_parser(@_);
2555 =head2 datetime_parser_type
2557 Defines (returns) the datetime parser class - currently hardwired to
2558 L<DateTime::Format::MySQL>
2562 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2564 =head2 build_datetime_parser
2566 See L</datetime_parser>
2570 sub build_datetime_parser {
2572 my $type = $self->datetime_parser_type(@_);
2573 $self->ensure_class_loaded ($type);
2578 =head2 is_replicating
2580 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2581 replicate from a master database. Default is undef, which is the result
2582 returned by databases that don't support replication.
2586 sub is_replicating {
2591 =head2 lag_behind_master
2593 Returns a number that represents a certain amount of lag behind a master db
2594 when a given storage is replicating. The number is database dependent, but
2595 starts at zero and increases with the amount of lag. Default in undef
2599 sub lag_behind_master {
2603 =head2 relname_to_table_alias
2607 =item Arguments: $relname, $join_count
2611 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2614 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2615 way these aliases are named.
2617 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2618 otherwise C<"$relname">.
2622 sub relname_to_table_alias {
2623 my ($self, $relname, $join_count) = @_;
2625 my $alias = ($join_count && $join_count > 1 ?
2626 join('_', $relname, $join_count) : $relname);
2635 =head2 DBIx::Class and AutoCommit
2637 DBIx::Class can do some wonderful magic with handling exceptions,
2638 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2639 (the default) combined with C<txn_do> for transaction support.
2641 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2642 in an assumed transaction between commits, and you're telling us you'd
2643 like to manage that manually. A lot of the magic protections offered by
2644 this module will go away. We can't protect you from exceptions due to database
2645 disconnects because we don't know anything about how to restart your
2646 transactions. You're on your own for handling all sorts of exceptional
2647 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2653 Matt S. Trout <mst@shadowcatsystems.co.uk>
2655 Andy Grundman <andy@hybridized.org>
2659 You may distribute this code under the same terms as Perl itself.