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();
19 __PACKAGE__->mk_group_accessors('simple' =>
20 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
21 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints/
24 # the values for these accessors are picked out (and deleted) from
25 # the attribute hashref passed to connect_info
26 my @storage_options = qw/
27 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
28 disable_sth_caching unsafe auto_savepoint
30 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
33 # default cursor class, overridable in connect_info attributes
34 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
36 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
37 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
40 # Each of these methods need _determine_driver called before itself
41 # in order to function reliably. This is a purely DRY optimization
42 my @rdbms_specific_methods = qw/
56 for my $meth (@rdbms_specific_methods) {
58 my $orig = __PACKAGE__->can ($meth)
62 no warnings qw/redefine/;
63 *{__PACKAGE__ ."::$meth"} = Sub::Name::subname $meth => sub {
64 if (not $_[0]->_driver_determined) {
65 $_[0]->_determine_driver;
66 goto $_[0]->can($meth);
75 DBIx::Class::Storage::DBI - DBI storage handler
79 my $schema = MySchema->connect('dbi:SQLite:my.db');
81 $schema->storage->debug(1);
83 my @stuff = $schema->storage->dbh_do(
85 my ($storage, $dbh, @args) = @_;
86 $dbh->do("DROP TABLE authors");
91 $schema->resultset('Book')->search({
92 written_on => $schema->storage->datetime_parser(DateTime->now)
97 This class represents the connection to an RDBMS via L<DBI>. See
98 L<DBIx::Class::Storage> for general information. This pod only
99 documents DBI-specific methods and behaviors.
106 my $new = shift->next::method(@_);
108 $new->transaction_depth(0);
109 $new->_sql_maker_opts({});
110 $new->{savepoints} = [];
111 $new->{_in_dbh_do} = 0;
112 $new->{_dbh_gen} = 0;
119 This method is normally called by L<DBIx::Class::Schema/connection>, which
120 encapsulates its argument list in an arrayref before passing them here.
122 The argument list may contain:
128 The same 4-element argument set one would normally pass to
129 L<DBI/connect>, optionally followed by
130 L<extra attributes|/DBIx::Class specific connection attributes>
131 recognized by DBIx::Class:
133 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
137 A single code reference which returns a connected
138 L<DBI database handle|DBI/connect> optionally followed by
139 L<extra attributes|/DBIx::Class specific connection attributes> recognized
142 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
146 A single hashref with all the attributes and the dsn/user/password
149 $connect_info_args = [{
157 $connect_info_args = [{
158 dbh_maker => sub { DBI->connect (...) },
163 This is particularly useful for L<Catalyst> based applications, allowing the
164 following config (L<Config::General> style):
169 dsn dbi:mysql:database=test
176 The C<dsn>/C<user>/C<password> combination can be substituted by the
177 C<dbh_maker> key whose value is a coderef that returns a connected
178 L<DBI database handle|DBI/connect>
182 Please note that the L<DBI> docs recommend that you always explicitly
183 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
184 recommends that it be set to I<1>, and that you perform transactions
185 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
186 to I<1> if you do not do explicitly set it to zero. This is the default
187 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
189 =head3 DBIx::Class specific connection attributes
191 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
192 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
193 the following connection options. These options can be mixed in with your other
194 L<DBI> connection attributes, or placed in a separate hashref
195 (C<\%extra_attributes>) as shown above.
197 Every time C<connect_info> is invoked, any previous settings for
198 these options will be cleared before setting the new ones, regardless of
199 whether any options are specified in the new C<connect_info>.
206 Specifies things to do immediately after connecting or re-connecting to
207 the database. Its value may contain:
213 This contains one SQL statement to execute.
215 =item an array reference
217 This contains SQL statements to execute in order. Each element contains
218 a string or a code reference that returns a string.
220 =item a code reference
222 This contains some code to execute. Unlike code references within an
223 array reference, its return value is ignored.
227 =item on_disconnect_do
229 Takes arguments in the same form as L</on_connect_do> and executes them
230 immediately before disconnecting from the database.
232 Note, this only runs if you explicitly call L</disconnect> on the
235 =item on_connect_call
237 A more generalized form of L</on_connect_do> that calls the specified
238 C<connect_call_METHOD> methods in your storage driver.
240 on_connect_do => 'select 1'
244 on_connect_call => [ [ do_sql => 'select 1' ] ]
246 Its values may contain:
252 Will call the C<connect_call_METHOD> method.
254 =item a code reference
256 Will execute C<< $code->($storage) >>
258 =item an array reference
260 Each value can be a method name or code reference.
262 =item an array of arrays
264 For each array, the first item is taken to be the C<connect_call_> method name
265 or code reference, and the rest are parameters to it.
269 Some predefined storage methods you may use:
275 Executes a SQL string or a code reference that returns a SQL string. This is
276 what L</on_connect_do> and L</on_disconnect_do> use.
284 Will execute the scalar as SQL.
288 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
289 attributes hashref and bind values.
291 =item a code reference
293 Will execute C<< $code->($storage) >> and execute the return array refs as
300 Execute any statements necessary to initialize the database session to return
301 and accept datetime/timestamp values used with
302 L<DBIx::Class::InflateColumn::DateTime>.
304 Only necessary for some databases, see your specific storage driver for
305 implementation details.
309 =item on_disconnect_call
311 Takes arguments in the same form as L</on_connect_call> and executes them
312 immediately before disconnecting from the database.
314 Calls the C<disconnect_call_METHOD> methods as opposed to the
315 C<connect_call_METHOD> methods called by L</on_connect_call>.
317 Note, this only runs if you explicitly call L</disconnect> on the
320 =item disable_sth_caching
322 If set to a true value, this option will disable the caching of
323 statement handles via L<DBI/prepare_cached>.
327 Sets the limit dialect. This is useful for JDBC-bridge among others
328 where the remote SQL-dialect cannot be determined by the name of the
329 driver alone. See also L<SQL::Abstract::Limit>.
333 Specifies what characters to use to quote table and column names. If
334 you use this you will want to specify L</name_sep> as well.
336 C<quote_char> expects either a single character, in which case is it
337 is placed on either side of the table/column name, or an arrayref of length
338 2 in which case the table/column name is placed between the elements.
340 For example under MySQL you should use C<< quote_char => '`' >>, and for
341 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
345 This only needs to be used in conjunction with C<quote_char>, and is used to
346 specify the character that separates elements (schemas, tables, columns) from
347 each other. In most cases this is simply a C<.>.
349 The consequences of not supplying this value is that L<SQL::Abstract>
350 will assume DBIx::Class' uses of aliases to be complete column
351 names. The output will look like I<"me.name"> when it should actually
356 This Storage driver normally installs its own C<HandleError>, sets
357 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
358 all database handles, including those supplied by a coderef. It does this
359 so that it can have consistent and useful error behavior.
361 If you set this option to a true value, Storage will not do its usual
362 modifications to the database handle's attributes, and instead relies on
363 the settings in your connect_info DBI options (or the values you set in
364 your connection coderef, in the case that you are connecting via coderef).
366 Note that your custom settings can cause Storage to malfunction,
367 especially if you set a C<HandleError> handler that suppresses exceptions
368 and/or disable C<RaiseError>.
372 If this option is true, L<DBIx::Class> will use savepoints when nesting
373 transactions, making it possible to recover from failure in the inner
374 transaction without having to abort all outer transactions.
378 Use this argument to supply a cursor class other than the default
379 L<DBIx::Class::Storage::DBI::Cursor>.
383 Some real-life examples of arguments to L</connect_info> and
384 L<DBIx::Class::Schema/connect>
386 # Simple SQLite connection
387 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
390 ->connect_info([ sub { DBI->connect(...) } ]);
392 # Connect via subref in hashref
394 dbh_maker => sub { DBI->connect(...) },
395 on_connect_do => 'alter session ...',
398 # A bit more complicated
405 { quote_char => q{"}, name_sep => q{.} },
409 # Equivalent to the previous example
415 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
419 # Same, but with hashref as argument
420 # See parse_connect_info for explanation
423 dsn => 'dbi:Pg:dbname=foo',
425 password => 'my_pg_password',
432 # Subref + DBIx::Class-specific connection options
435 sub { DBI->connect(...) },
439 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
440 disable_sth_caching => 1,
450 my ($self, $info) = @_;
452 return $self->_connect_info if !$info;
454 $self->_connect_info($info); # copy for _connect_info
456 $info = $self->_normalize_connect_info($info)
457 if ref $info eq 'ARRAY';
459 for my $storage_opt (keys %{ $info->{storage_options} }) {
460 my $value = $info->{storage_options}{$storage_opt};
462 $self->$storage_opt($value);
465 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
466 # the new set of options
467 $self->_sql_maker(undef);
468 $self->_sql_maker_opts({});
470 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
471 my $value = $info->{sql_maker_options}{$sql_maker_opt};
473 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
477 %{ $self->_default_dbi_connect_attributes || {} },
478 %{ $info->{attributes} || {} },
481 my @args = @{ $info->{arguments} };
483 $self->_dbi_connect_info([@args,
484 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
486 return $self->_connect_info;
489 sub _normalize_connect_info {
490 my ($self, $info_arg) = @_;
493 my @args = @$info_arg; # take a shallow copy for further mutilation
495 # combine/pre-parse arguments depending on invocation style
498 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
499 %attrs = %{ $args[1] || {} };
502 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
503 %attrs = %{$args[0]};
505 if (my $code = delete $attrs{dbh_maker}) {
508 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
511 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
512 . "to the result of 'dbh_maker'",
514 join (', ', map { "'$_'" } (@ignored) ),
519 @args = delete @attrs{qw/dsn user password/};
522 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
524 % { $args[3] || {} },
525 % { $args[4] || {} },
527 @args = @args[0,1,2];
530 $info{arguments} = \@args;
532 my @storage_opts = grep exists $attrs{$_},
533 @storage_options, 'cursor_class';
535 @{ $info{storage_options} }{@storage_opts} =
536 delete @attrs{@storage_opts} if @storage_opts;
538 my @sql_maker_opts = grep exists $attrs{$_},
539 qw/limit_dialect quote_char name_sep/;
541 @{ $info{sql_maker_options} }{@sql_maker_opts} =
542 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
544 $info{attributes} = \%attrs if %attrs;
549 sub _default_dbi_connect_attributes {
559 This method is deprecated in favour of setting via L</connect_info>.
563 =head2 on_disconnect_do
565 This method is deprecated in favour of setting via L</connect_info>.
569 sub _parse_connect_do {
570 my ($self, $type) = @_;
572 my $val = $self->$type;
573 return () if not defined $val;
578 push @res, [ 'do_sql', $val ];
579 } elsif (ref($val) eq 'CODE') {
581 } elsif (ref($val) eq 'ARRAY') {
582 push @res, map { [ 'do_sql', $_ ] } @$val;
584 $self->throw_exception("Invalid type for $type: ".ref($val));
592 Arguments: ($subref | $method_name), @extra_coderef_args?
594 Execute the given $subref or $method_name using the new exception-based
595 connection management.
597 The first two arguments will be the storage object that C<dbh_do> was called
598 on and a database handle to use. Any additional arguments will be passed
599 verbatim to the called subref as arguments 2 and onwards.
601 Using this (instead of $self->_dbh or $self->dbh) ensures correct
602 exception handling and reconnection (or failover in future subclasses).
604 Your subref should have no side-effects outside of the database, as
605 there is the potential for your subref to be partially double-executed
606 if the database connection was stale/dysfunctional.
610 my @stuff = $schema->storage->dbh_do(
612 my ($storage, $dbh, @cols) = @_;
613 my $cols = join(q{, }, @cols);
614 $dbh->selectrow_array("SELECT $cols FROM foo");
625 my $dbh = $self->_get_dbh;
627 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
628 || $self->{transaction_depth};
630 local $self->{_in_dbh_do} = 1;
633 my $want_array = wantarray;
638 @result = $self->$code($dbh, @_);
640 elsif(defined $want_array) {
641 $result[0] = $self->$code($dbh, @_);
644 $self->$code($dbh, @_);
648 # ->connected might unset $@ - copy
650 if(!$exception) { return $want_array ? @result : $result[0] }
652 $self->throw_exception($exception) if $self->connected;
654 # We were not connected - reconnect and retry, but let any
655 # exception fall right through this time
656 carp "Retrying $code after catching disconnected exception: $exception"
657 if $ENV{DBIC_DBIRETRY_DEBUG};
658 $self->_populate_dbh;
659 $self->$code($self->_dbh, @_);
662 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
663 # It also informs dbh_do to bypass itself while under the direction of txn_do,
664 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
669 ref $coderef eq 'CODE' or $self->throw_exception
670 ('$coderef must be a CODE reference');
672 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
674 local $self->{_in_dbh_do} = 1;
677 my $want_array = wantarray;
686 @result = $coderef->(@_);
688 elsif(defined $want_array) {
689 $result[0] = $coderef->(@_);
697 # ->connected might unset $@ - copy
699 if(!$exception) { return $want_array ? @result : $result[0] }
701 if($tried++ || $self->connected) {
702 eval { $self->txn_rollback };
703 my $rollback_exception = $@;
704 if($rollback_exception) {
705 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
706 $self->throw_exception($exception) # propagate nested rollback
707 if $rollback_exception =~ /$exception_class/;
709 $self->throw_exception(
710 "Transaction aborted: ${exception}. "
711 . "Rollback failed: ${rollback_exception}"
714 $self->throw_exception($exception)
717 # We were not connected, and was first try - reconnect and retry
719 carp "Retrying $coderef after catching disconnected exception: $exception"
720 if $ENV{DBIC_DBIRETRY_DEBUG};
721 $self->_populate_dbh;
727 Our C<disconnect> method also performs a rollback first if the
728 database is not in C<AutoCommit> mode.
738 push @actions, ( $self->on_disconnect_call || () );
739 push @actions, $self->_parse_connect_do ('on_disconnect_do');
741 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
743 $self->_dbh_rollback unless $self->_dbh_autocommit;
745 $self->_dbh->disconnect;
751 =head2 with_deferred_fk_checks
755 =item Arguments: C<$coderef>
757 =item Return Value: The return value of $coderef
761 Storage specific method to run the code ref with FK checks deferred or
762 in MySQL's case disabled entirely.
766 # Storage subclasses should override this
767 sub with_deferred_fk_checks {
768 my ($self, $sub) = @_;
776 =item Arguments: none
778 =item Return Value: 1|0
782 Verifies that the current database handle is active and ready to execute
783 an SQL statement (e.g. the connection did not get stale, server is still
784 answering, etc.) This method is used internally by L</dbh>.
790 return 0 unless $self->_seems_connected;
793 local $self->_dbh->{RaiseError} = 1;
798 sub _seems_connected {
801 my $dbh = $self->_dbh
804 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
811 return 0 if !$self->_dbh;
814 return $dbh->FETCH('Active');
820 my $dbh = $self->_dbh or return 0;
825 # handle pid changes correctly
826 # NOTE: assumes $self->_dbh is a valid $dbh
830 return if defined $self->_conn_pid && $self->_conn_pid == $$;
832 $self->_dbh->{InactiveDestroy} = 1;
839 sub ensure_connected {
842 unless ($self->connected) {
843 $self->_populate_dbh;
849 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
850 is guaranteed to be healthy by implicitly calling L</connected>, and if
851 necessary performing a reconnection before returning. Keep in mind that this
852 is very B<expensive> on some database engines. Consider using L<dbh_do>
860 if (not $self->_dbh) {
861 $self->_populate_dbh;
863 $self->ensure_connected;
868 # this is the internal "get dbh or connect (don't check)" method
871 $self->_verify_pid if $self->_dbh;
872 $self->_populate_dbh unless $self->_dbh;
876 sub _sql_maker_args {
881 array_datatypes => 1,
882 limit_dialect => $self->_get_dbh,
883 %{$self->_sql_maker_opts}
889 unless ($self->_sql_maker) {
890 my $sql_maker_class = $self->sql_maker_class;
891 $self->ensure_class_loaded ($sql_maker_class);
892 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
894 return $self->_sql_maker;
897 # nothing to do by default
904 my @info = @{$self->_dbi_connect_info || []};
905 $self->_dbh(undef); # in case ->connected failed we might get sent here
906 $self->_dbh($self->_connect(@info));
908 $self->_conn_pid($$);
909 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
911 $self->_determine_driver;
913 # Always set the transaction depth on connect, since
914 # there is no transaction in progress by definition
915 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
917 $self->_run_connection_actions unless $self->{_in_determine_driver};
920 sub _run_connection_actions {
924 push @actions, ( $self->on_connect_call || () );
925 push @actions, $self->_parse_connect_do ('on_connect_do');
927 $self->_do_connection_actions(connect_call_ => $_) for @actions;
930 sub _determine_driver {
933 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
934 my $started_connected = 0;
935 local $self->{_in_determine_driver} = 1;
937 if (ref($self) eq __PACKAGE__) {
939 if ($self->_dbh) { # we are connected
940 $driver = $self->_dbh->{Driver}{Name};
941 $started_connected = 1;
943 # if connect_info is a CODEREF, we have no choice but to connect
944 if (ref $self->_dbi_connect_info->[0] &&
945 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
946 $self->_populate_dbh;
947 $driver = $self->_dbh->{Driver}{Name};
950 # try to use dsn to not require being connected, the driver may still
951 # force a connection in _rebless to determine version
952 # (dsn may not be supplied at all if all we do is make a mock-schema)
953 my $dsn = $self->_dbi_connect_info->[0] || '';
954 ($driver) = $dsn =~ /dbi:([^:]+):/i;
959 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
960 if ($self->load_optional_class($storage_class)) {
961 mro::set_mro($storage_class, 'c3');
962 bless $self, $storage_class;
968 $self->_driver_determined(1);
970 $self->_init; # run driver-specific initializations
972 $self->_run_connection_actions
973 if !$started_connected && defined $self->_dbh;
977 sub _do_connection_actions {
979 my $method_prefix = shift;
982 if (not ref($call)) {
983 my $method = $method_prefix . $call;
985 } elsif (ref($call) eq 'CODE') {
987 } elsif (ref($call) eq 'ARRAY') {
988 if (ref($call->[0]) ne 'ARRAY') {
989 $self->_do_connection_actions($method_prefix, $_) for @$call;
991 $self->_do_connection_actions($method_prefix, @$_) for @$call;
994 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1000 sub connect_call_do_sql {
1002 $self->_do_query(@_);
1005 sub disconnect_call_do_sql {
1007 $self->_do_query(@_);
1010 # override in db-specific backend when necessary
1011 sub connect_call_datetime_setup { 1 }
1014 my ($self, $action) = @_;
1016 if (ref $action eq 'CODE') {
1017 $action = $action->($self);
1018 $self->_do_query($_) foreach @$action;
1021 # Most debuggers expect ($sql, @bind), so we need to exclude
1022 # the attribute hash which is the second argument to $dbh->do
1023 # furthermore the bind values are usually to be presented
1024 # as named arrayref pairs, so wrap those here too
1025 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1026 my $sql = shift @do_args;
1027 my $attrs = shift @do_args;
1028 my @bind = map { [ undef, $_ ] } @do_args;
1030 $self->_query_start($sql, @bind);
1031 $self->_get_dbh->do($sql, $attrs, @do_args);
1032 $self->_query_end($sql, @bind);
1039 my ($self, @info) = @_;
1041 $self->throw_exception("You failed to provide any connection info")
1044 my ($old_connect_via, $dbh);
1046 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1047 $old_connect_via = $DBI::connect_via;
1048 $DBI::connect_via = 'connect';
1052 if(ref $info[0] eq 'CODE') {
1053 $dbh = $info[0]->();
1056 $dbh = DBI->connect(@info);
1059 if($dbh && !$self->unsafe) {
1060 my $weak_self = $self;
1061 Scalar::Util::weaken($weak_self);
1062 $dbh->{HandleError} = sub {
1064 $weak_self->throw_exception("DBI Exception: $_[0]");
1067 # the handler may be invoked by something totally out of
1069 croak ("DBI Exception: $_[0]");
1072 $dbh->{ShowErrorStatement} = 1;
1073 $dbh->{RaiseError} = 1;
1074 $dbh->{PrintError} = 0;
1078 $DBI::connect_via = $old_connect_via if $old_connect_via;
1080 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1083 $self->_dbh_autocommit($dbh->{AutoCommit});
1089 my ($self, $name) = @_;
1091 $name = $self->_svp_generate_name
1092 unless defined $name;
1094 $self->throw_exception ("You can't use savepoints outside a transaction")
1095 if $self->{transaction_depth} == 0;
1097 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1098 unless $self->can('_svp_begin');
1100 push @{ $self->{savepoints} }, $name;
1102 $self->debugobj->svp_begin($name) if $self->debug;
1104 return $self->_svp_begin($name);
1108 my ($self, $name) = @_;
1110 $self->throw_exception ("You can't use savepoints outside a transaction")
1111 if $self->{transaction_depth} == 0;
1113 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1114 unless $self->can('_svp_release');
1116 if (defined $name) {
1117 $self->throw_exception ("Savepoint '$name' does not exist")
1118 unless grep { $_ eq $name } @{ $self->{savepoints} };
1120 # Dig through the stack until we find the one we are releasing. This keeps
1121 # the stack up to date.
1124 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1126 $name = pop @{ $self->{savepoints} };
1129 $self->debugobj->svp_release($name) if $self->debug;
1131 return $self->_svp_release($name);
1135 my ($self, $name) = @_;
1137 $self->throw_exception ("You can't use savepoints outside a transaction")
1138 if $self->{transaction_depth} == 0;
1140 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1141 unless $self->can('_svp_rollback');
1143 if (defined $name) {
1144 # If they passed us a name, verify that it exists in the stack
1145 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1146 $self->throw_exception("Savepoint '$name' does not exist!");
1149 # Dig through the stack until we find the one we are releasing. This keeps
1150 # the stack up to date.
1151 while(my $s = pop(@{ $self->{savepoints} })) {
1152 last if($s eq $name);
1154 # Add the savepoint back to the stack, as a rollback doesn't remove the
1155 # named savepoint, only everything after it.
1156 push(@{ $self->{savepoints} }, $name);
1158 # We'll assume they want to rollback to the last savepoint
1159 $name = $self->{savepoints}->[-1];
1162 $self->debugobj->svp_rollback($name) if $self->debug;
1164 return $self->_svp_rollback($name);
1167 sub _svp_generate_name {
1170 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1176 # this means we have not yet connected and do not know the AC status
1177 # (e.g. coderef $dbh)
1178 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1180 if($self->{transaction_depth} == 0) {
1181 $self->debugobj->txn_begin()
1183 $self->_dbh_begin_work;
1185 elsif ($self->auto_savepoint) {
1188 $self->{transaction_depth}++;
1191 sub _dbh_begin_work {
1194 # if the user is utilizing txn_do - good for him, otherwise we need to
1195 # ensure that the $dbh is healthy on BEGIN.
1196 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1197 # will be replaced by a failure of begin_work itself (which will be
1198 # then retried on reconnect)
1199 if ($self->{_in_dbh_do}) {
1200 $self->_dbh->begin_work;
1202 $self->dbh_do(sub { $_[1]->begin_work });
1208 if ($self->{transaction_depth} == 1) {
1209 $self->debugobj->txn_commit()
1212 $self->{transaction_depth} = 0
1213 if $self->_dbh_autocommit;
1215 elsif($self->{transaction_depth} > 1) {
1216 $self->{transaction_depth}--;
1218 if $self->auto_savepoint;
1224 my $dbh = $self->_dbh
1225 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1231 my $dbh = $self->_dbh;
1233 if ($self->{transaction_depth} == 1) {
1234 $self->debugobj->txn_rollback()
1236 $self->{transaction_depth} = 0
1237 if $self->_dbh_autocommit;
1238 $self->_dbh_rollback;
1240 elsif($self->{transaction_depth} > 1) {
1241 $self->{transaction_depth}--;
1242 if ($self->auto_savepoint) {
1243 $self->svp_rollback;
1248 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1253 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1254 $error =~ /$exception_class/ and $self->throw_exception($error);
1255 # ensure that a failed rollback resets the transaction depth
1256 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1257 $self->throw_exception($error);
1263 my $dbh = $self->_dbh
1264 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1268 # This used to be the top-half of _execute. It was split out to make it
1269 # easier to override in NoBindVars without duping the rest. It takes up
1270 # all of _execute's args, and emits $sql, @bind.
1271 sub _prep_for_execute {
1272 my ($self, $op, $extra_bind, $ident, $args) = @_;
1274 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1275 $ident = $ident->from();
1278 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1281 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1283 return ($sql, \@bind);
1287 sub _fix_bind_params {
1288 my ($self, @bind) = @_;
1290 ### Turn @bind from something like this:
1291 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1293 ### ( "'1'", "'1'", "'3'" )
1296 if ( defined( $_ && $_->[1] ) ) {
1297 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1304 my ( $self, $sql, @bind ) = @_;
1306 if ( $self->debug ) {
1307 @bind = $self->_fix_bind_params(@bind);
1309 $self->debugobj->query_start( $sql, @bind );
1314 my ( $self, $sql, @bind ) = @_;
1316 if ( $self->debug ) {
1317 @bind = $self->_fix_bind_params(@bind);
1318 $self->debugobj->query_end( $sql, @bind );
1323 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1325 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1327 $self->_query_start( $sql, @$bind );
1329 my $sth = $self->sth($sql,$op);
1331 my $placeholder_index = 1;
1333 foreach my $bound (@$bind) {
1334 my $attributes = {};
1335 my($column_name, @data) = @$bound;
1337 if ($bind_attributes) {
1338 $attributes = $bind_attributes->{$column_name}
1339 if defined $bind_attributes->{$column_name};
1342 foreach my $data (@data) {
1343 my $ref = ref $data;
1344 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1346 $sth->bind_param($placeholder_index, $data, $attributes);
1347 $placeholder_index++;
1351 # Can this fail without throwing an exception anyways???
1352 my $rv = $sth->execute();
1353 $self->throw_exception($sth->errstr) if !$rv;
1355 $self->_query_end( $sql, @$bind );
1357 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1362 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1366 my ($self, $source, $to_insert) = @_;
1368 my $ident = $source->from;
1369 my $bind_attributes = $self->source_bind_attributes($source);
1371 my $updated_cols = {};
1373 foreach my $col ( $source->columns ) {
1374 if ( !defined $to_insert->{$col} ) {
1375 my $col_info = $source->column_info($col);
1377 if ( $col_info->{auto_nextval} ) {
1378 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1380 $col_info->{sequence} ||
1381 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1387 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1389 return $updated_cols;
1392 ## Currently it is assumed that all values passed will be "normal", i.e. not
1393 ## scalar refs, or at least, all the same type as the first set, the statement is
1394 ## only prepped once.
1396 my ($self, $source, $cols, $data) = @_;
1399 @colvalues{@$cols} = (0..$#$cols);
1401 for my $i (0..$#$cols) {
1402 my $first_val = $data->[0][$i];
1403 next unless ref $first_val eq 'SCALAR';
1405 $colvalues{ $cols->[$i] } = $first_val;
1408 # check for bad data and stringify stringifiable objects
1409 my $bad_slice = sub {
1410 my ($msg, $col_idx, $slice_idx) = @_;
1411 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1415 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1416 Data::Dumper::Concise::Dumper({
1417 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1423 for my $datum_idx (0..$#$data) {
1424 my $datum = $data->[$datum_idx];
1426 for my $col_idx (0..$#$cols) {
1427 my $val = $datum->[$col_idx];
1428 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1429 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1431 if ($is_literal_sql) {
1433 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1435 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1436 $bad_slice->("$reftype reference found where literal SQL expected",
1437 $col_idx, $datum_idx);
1439 elsif ($$val ne $$sqla_bind){
1440 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1441 $col_idx, $datum_idx);
1444 elsif (my $reftype = ref $val) {
1446 if (overload::Method($val, '""')) {
1447 $datum->[$col_idx] = "".$val;
1450 $bad_slice->("$reftype reference found where bind expected",
1451 $col_idx, $datum_idx);
1457 my ($sql, $bind) = $self->_prep_for_execute (
1458 'insert', undef, $source, [\%colvalues]
1462 my $empty_bind = 1 if (not @bind) &&
1463 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1465 if ((not @bind) && (not $empty_bind)) {
1466 $self->throw_exception(
1467 'Cannot insert_bulk without support for placeholders'
1471 # neither _execute_array, nor _execute_inserts_with_no_binds are
1472 # atomic (even if _execute _array is a single call). Thus a safety
1474 my $guard = $self->txn_scope_guard unless $self->{transaction_depth} != 0;
1476 $self->_query_start( $sql, ['__BULK__'] );
1477 my $sth = $self->sth($sql);
1480 # bind_param_array doesn't work if there are no binds
1481 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1484 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1485 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1489 $self->_query_end( $sql, ['__BULK__'] );
1492 $guard->commit if $guard;
1494 return (wantarray ? ($rv, $sth, @bind) : $rv);
1497 sub _execute_array {
1498 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1500 ## This must be an arrayref, else nothing works!
1501 my $tuple_status = [];
1503 ## Get the bind_attributes, if any exist
1504 my $bind_attributes = $self->source_bind_attributes($source);
1506 ## Bind the values and execute
1507 my $placeholder_index = 1;
1509 foreach my $bound (@$bind) {
1511 my $attributes = {};
1512 my ($column_name, $data_index) = @$bound;
1514 if( $bind_attributes ) {
1515 $attributes = $bind_attributes->{$column_name}
1516 if defined $bind_attributes->{$column_name};
1519 my @data = map { $_->[$data_index] } @$data;
1521 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1522 $placeholder_index++;
1526 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1528 my $err = $@ || $sth->errstr;
1530 # Statement must finish even if there was an exception.
1531 eval { $sth->finish };
1532 $err = $@ unless $err;
1536 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1538 $self->throw_exception("Unexpected populate error: $err")
1539 if ($i > $#$tuple_status);
1541 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1542 ($tuple_status->[$i][1] || $err),
1543 Data::Dumper::Concise::Dumper({
1544 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1551 sub _dbh_execute_array {
1552 my ($self, $sth, $tuple_status, @extra) = @_;
1554 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1557 sub _dbh_execute_inserts_with_no_binds {
1558 my ($self, $sth, $count) = @_;
1561 my $dbh = $self->_get_dbh;
1562 local $dbh->{RaiseError} = 1;
1563 local $dbh->{PrintError} = 0;
1565 $sth->execute foreach 1..$count;
1569 # Make sure statement is finished even if there was an exception.
1570 eval { $sth->finish };
1571 $exception = $@ unless $exception;
1573 $self->throw_exception($exception) if $exception;
1579 my ($self, $source, @args) = @_;
1581 my $bind_attrs = $self->source_bind_attributes($source);
1583 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1588 my ($self, $source, @args) = @_;
1590 my $bind_attrs = $self->source_bind_attributes($source);
1592 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1595 # We were sent here because the $rs contains a complex search
1596 # which will require a subquery to select the correct rows
1597 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1599 # Generating a single PK column subquery is trivial and supported
1600 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1601 # Look at _multipk_update_delete()
1602 sub _subq_update_delete {
1604 my ($rs, $op, $values) = @_;
1606 my $rsrc = $rs->result_source;
1608 # quick check if we got a sane rs on our hands
1609 my @pcols = $rsrc->_pri_cols;
1611 my $sel = $rs->_resolved_attrs->{select};
1612 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1615 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1617 join ("\x00", sort @$sel )
1619 $self->throw_exception (
1620 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1627 $op eq 'update' ? $values : (),
1628 { $pcols[0] => { -in => $rs->as_query } },
1633 return $self->_multipk_update_delete (@_);
1637 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1638 # resultset update/delete involving subqueries. So by default resort
1639 # to simple (and inefficient) delete_all style per-row opearations,
1640 # while allowing specific storages to override this with a faster
1643 sub _multipk_update_delete {
1644 return shift->_per_row_update_delete (@_);
1647 # This is the default loop used to delete/update rows for multi PK
1648 # resultsets, and used by mysql exclusively (because it can't do anything
1651 # We do not use $row->$op style queries, because resultset update/delete
1652 # is not expected to cascade (this is what delete_all/update_all is for).
1654 # There should be no race conditions as the entire operation is rolled
1657 sub _per_row_update_delete {
1659 my ($rs, $op, $values) = @_;
1661 my $rsrc = $rs->result_source;
1662 my @pcols = $rsrc->_pri_cols;
1664 my $guard = $self->txn_scope_guard;
1666 # emulate the return value of $sth->execute for non-selects
1667 my $row_cnt = '0E0';
1669 my $subrs_cur = $rs->cursor;
1670 my @all_pk = $subrs_cur->all;
1671 for my $pks ( @all_pk) {
1674 for my $i (0.. $#pcols) {
1675 $cond->{$pcols[$i]} = $pks->[$i];
1680 $op eq 'update' ? $values : (),
1695 # localization is neccessary as
1696 # 1) there is no infrastructure to pass this around before SQLA2
1697 # 2) _select_args sets it and _prep_for_execute consumes it
1698 my $sql_maker = $self->sql_maker;
1699 local $sql_maker->{_dbic_rs_attrs};
1701 return $self->_execute($self->_select_args(@_));
1704 sub _select_args_to_query {
1707 # localization is neccessary as
1708 # 1) there is no infrastructure to pass this around before SQLA2
1709 # 2) _select_args sets it and _prep_for_execute consumes it
1710 my $sql_maker = $self->sql_maker;
1711 local $sql_maker->{_dbic_rs_attrs};
1713 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1714 # = $self->_select_args($ident, $select, $cond, $attrs);
1715 my ($op, $bind, $ident, $bind_attrs, @args) =
1716 $self->_select_args(@_);
1718 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1719 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1720 $prepared_bind ||= [];
1723 ? ($sql, $prepared_bind, $bind_attrs)
1724 : \[ "($sql)", @$prepared_bind ]
1729 my ($self, $ident, $select, $where, $attrs) = @_;
1731 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1733 my $sql_maker = $self->sql_maker;
1734 $sql_maker->{_dbic_rs_attrs} = {
1739 $rs_alias && $alias2source->{$rs_alias}
1740 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1745 # calculate bind_attrs before possible $ident mangling
1746 my $bind_attrs = {};
1747 for my $alias (keys %$alias2source) {
1748 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1749 for my $col (keys %$bindtypes) {
1751 my $fqcn = join ('.', $alias, $col);
1752 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1754 # Unqialified column names are nice, but at the same time can be
1755 # rather ambiguous. What we do here is basically go along with
1756 # the loop, adding an unqualified column slot to $bind_attrs,
1757 # alongside the fully qualified name. As soon as we encounter
1758 # another column by that name (which would imply another table)
1759 # we unset the unqualified slot and never add any info to it
1760 # to avoid erroneous type binding. If this happens the users
1761 # only choice will be to fully qualify his column name
1763 if (exists $bind_attrs->{$col}) {
1764 $bind_attrs->{$col} = {};
1767 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1774 $attrs->{software_limit}
1776 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1778 $attrs->{software_limit} = 1;
1781 $self->throw_exception("rows attribute must be positive if present")
1782 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1784 # MySQL actually recommends this approach. I cringe.
1785 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1790 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1791 # storage, unless software limit was requested
1794 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1796 # limited prefetch with RNO subqueries
1800 $sql_maker->limit_dialect eq 'RowNumberOver'
1802 $attrs->{_prefetch_select}
1804 @{$attrs->{_prefetch_select}}
1808 ( $attrs->{group_by}
1810 @{$attrs->{group_by}}
1812 $attrs->{_prefetch_select}
1814 @{$attrs->{_prefetch_select}}
1817 ($ident, $select, $where, $attrs)
1818 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1822 ($attrs->{rows} || $attrs->{offset})
1824 $sql_maker->limit_dialect eq 'RowNumberOver'
1826 (ref $ident eq 'ARRAY' && @$ident > 1) # indicates a join
1828 scalar $self->_parse_order_by ($attrs->{order_by})
1830 # the RNO limit dialect above mangles the SQL such that the join gets lost
1831 # wrap a subquery here
1833 push @limit, delete @{$attrs}{qw/rows offset/};
1835 my $subq = $self->_select_args_to_query (
1843 -alias => $attrs->{alias},
1844 -source_handle => $ident->[0]{-source_handle},
1845 $attrs->{alias} => $subq,
1848 # all part of the subquery now
1849 delete @{$attrs}{qw/order_by group_by having/};
1853 elsif (! $attrs->{software_limit} ) {
1854 push @limit, $attrs->{rows}, $attrs->{offset};
1857 # try to simplify the joinmap further (prune unreferenced type-single joins)
1858 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1861 # This would be the point to deflate anything found in $where
1862 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1863 # expect a row object. And all we have is a resultsource (it is trivial
1864 # to extract deflator coderefs via $alias2source above).
1866 # I don't see a way forward other than changing the way deflators are
1867 # invoked, and that's just bad...
1871 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1872 (qw/order_by group_by having/ )
1875 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1878 # Returns a counting SELECT for a simple count
1879 # query. Abstracted so that a storage could override
1880 # this to { count => 'firstcol' } or whatever makes
1881 # sense as a performance optimization
1883 #my ($self, $source, $rs_attrs) = @_;
1884 return { count => '*' };
1887 # Returns a SELECT which will end up in the subselect
1888 # There may or may not be a group_by, as the subquery
1889 # might have been called to accomodate a limit
1891 # Most databases would be happy with whatever ends up
1892 # here, but some choke in various ways.
1894 sub _subq_count_select {
1895 my ($self, $source, $rs_attrs) = @_;
1897 if (my $groupby = $rs_attrs->{group_by}) {
1899 my $avail_columns = $self->_resolve_column_info ($rs_attrs->{from});
1902 for my $sel (@{$rs_attrs->{select}}) {
1903 if (ref $sel eq 'HASH' and $sel->{-as}) {
1904 $sel_index->{$sel->{-as}} = $sel;
1909 for my $g_part (@$groupby) {
1910 if (ref $g_part or $avail_columns->{$g_part}) {
1911 push @selection, $g_part;
1913 elsif ($sel_index->{$g_part}) {
1914 push @selection, $sel_index->{$g_part};
1917 $self->throw_exception ("group_by criteria '$g_part' not contained within current resultset source(s)");
1924 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1925 return @pcols ? \@pcols : [ 1 ];
1928 sub source_bind_attributes {
1929 my ($self, $source) = @_;
1931 my $bind_attributes;
1932 foreach my $column ($source->columns) {
1934 my $data_type = $source->column_info($column)->{data_type} || '';
1935 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1939 return $bind_attributes;
1946 =item Arguments: $ident, $select, $condition, $attrs
1950 Handle a SQL select statement.
1956 my ($ident, $select, $condition, $attrs) = @_;
1957 return $self->cursor_class->new($self, \@_, $attrs);
1962 my ($rv, $sth, @bind) = $self->_select(@_);
1963 my @row = $sth->fetchrow_array;
1964 my @nextrow = $sth->fetchrow_array if @row;
1965 if(@row && @nextrow) {
1966 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1968 # Need to call finish() to work round broken DBDs
1977 =item Arguments: $sql
1981 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1986 my ($self, $dbh, $sql) = @_;
1988 # 3 is the if_active parameter which avoids active sth re-use
1989 my $sth = $self->disable_sth_caching
1990 ? $dbh->prepare($sql)
1991 : $dbh->prepare_cached($sql, {}, 3);
1993 # XXX You would think RaiseError would make this impossible,
1994 # but apparently that's not true :(
1995 $self->throw_exception($dbh->errstr) if !$sth;
2001 my ($self, $sql) = @_;
2002 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2005 sub _dbh_columns_info_for {
2006 my ($self, $dbh, $table) = @_;
2008 if ($dbh->can('column_info')) {
2011 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2012 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2014 while ( my $info = $sth->fetchrow_hashref() ){
2016 $column_info{data_type} = $info->{TYPE_NAME};
2017 $column_info{size} = $info->{COLUMN_SIZE};
2018 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2019 $column_info{default_value} = $info->{COLUMN_DEF};
2020 my $col_name = $info->{COLUMN_NAME};
2021 $col_name =~ s/^\"(.*)\"$/$1/;
2023 $result{$col_name} = \%column_info;
2026 return \%result if !$@ && scalar keys %result;
2030 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2032 my @columns = @{$sth->{NAME_lc}};
2033 for my $i ( 0 .. $#columns ){
2035 $column_info{data_type} = $sth->{TYPE}->[$i];
2036 $column_info{size} = $sth->{PRECISION}->[$i];
2037 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2039 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2040 $column_info{data_type} = $1;
2041 $column_info{size} = $2;
2044 $result{$columns[$i]} = \%column_info;
2048 foreach my $col (keys %result) {
2049 my $colinfo = $result{$col};
2050 my $type_num = $colinfo->{data_type};
2052 if(defined $type_num && $dbh->can('type_info')) {
2053 my $type_info = $dbh->type_info($type_num);
2054 $type_name = $type_info->{TYPE_NAME} if $type_info;
2055 $colinfo->{data_type} = $type_name if $type_name;
2062 sub columns_info_for {
2063 my ($self, $table) = @_;
2064 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2067 =head2 last_insert_id
2069 Return the row id of the last insert.
2073 sub _dbh_last_insert_id {
2074 my ($self, $dbh, $source, $col) = @_;
2076 my $id = eval { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2078 return $id if defined $id;
2080 my $class = ref $self;
2081 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2084 sub last_insert_id {
2086 $self->_dbh_last_insert_id ($self->_dbh, @_);
2089 =head2 _native_data_type
2093 =item Arguments: $type_name
2097 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2098 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2099 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2101 The default implementation returns C<undef>, implement in your Storage driver if
2102 you need this functionality.
2104 Should map types from other databases to the native RDBMS type, for example
2105 C<VARCHAR2> to C<VARCHAR>.
2107 Types with modifiers should map to the underlying data type. For example,
2108 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2110 Composite types should map to the container type, for example
2111 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2115 sub _native_data_type {
2116 #my ($self, $data_type) = @_;
2120 # Check if placeholders are supported at all
2121 sub _placeholders_supported {
2123 my $dbh = $self->_get_dbh;
2125 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2126 # but it is inaccurate more often than not
2128 local $dbh->{PrintError} = 0;
2129 local $dbh->{RaiseError} = 1;
2130 $dbh->do('select ?', {}, 1);
2135 # Check if placeholders bound to non-string types throw exceptions
2137 sub _typeless_placeholders_supported {
2139 my $dbh = $self->_get_dbh;
2142 local $dbh->{PrintError} = 0;
2143 local $dbh->{RaiseError} = 1;
2144 # this specifically tests a bind that is NOT a string
2145 $dbh->do('select 1 where 1 = ?', {}, 1);
2152 Returns the database driver name.
2157 shift->_get_dbh->{Driver}->{Name};
2160 =head2 bind_attribute_by_data_type
2162 Given a datatype from column info, returns a database specific bind
2163 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2164 let the database planner just handle it.
2166 Generally only needed for special case column types, like bytea in postgres.
2170 sub bind_attribute_by_data_type {
2174 =head2 is_datatype_numeric
2176 Given a datatype from column_info, returns a boolean value indicating if
2177 the current RDBMS considers it a numeric value. This controls how
2178 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2179 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2180 be performed instead of the usual C<eq>.
2184 sub is_datatype_numeric {
2185 my ($self, $dt) = @_;
2187 return 0 unless $dt;
2189 return $dt =~ /^ (?:
2190 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2195 =head2 create_ddl_dir
2199 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2203 Creates a SQL file based on the Schema, for each of the specified
2204 database engines in C<\@databases> in the given directory.
2205 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2207 Given a previous version number, this will also create a file containing
2208 the ALTER TABLE statements to transform the previous schema into the
2209 current one. Note that these statements may contain C<DROP TABLE> or
2210 C<DROP COLUMN> statements that can potentially destroy data.
2212 The file names are created using the C<ddl_filename> method below, please
2213 override this method in your schema if you would like a different file
2214 name format. For the ALTER file, the same format is used, replacing
2215 $version in the name with "$preversion-$version".
2217 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2218 The most common value for this would be C<< { add_drop_table => 1 } >>
2219 to have the SQL produced include a C<DROP TABLE> statement for each table
2220 created. For quoting purposes supply C<quote_table_names> and
2221 C<quote_field_names>.
2223 If no arguments are passed, then the following default values are assumed:
2227 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2229 =item version - $schema->schema_version
2231 =item directory - './'
2233 =item preversion - <none>
2237 By default, C<\%sqlt_args> will have
2239 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2241 merged with the hash passed in. To disable any of those features, pass in a
2242 hashref like the following
2244 { ignore_constraint_names => 0, # ... other options }
2247 WARNING: You are strongly advised to check all SQL files created, before applying
2252 sub create_ddl_dir {
2253 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2255 if(!$dir || !-d $dir) {
2256 carp "No directory given, using ./\n";
2259 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2260 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2262 my $schema_version = $schema->schema_version || '1.x';
2263 $version ||= $schema_version;
2266 add_drop_table => 1,
2267 ignore_constraint_names => 1,
2268 ignore_index_names => 1,
2272 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2273 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2276 my $sqlt = SQL::Translator->new( $sqltargs );
2278 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2279 my $sqlt_schema = $sqlt->translate({ data => $schema })
2280 or $self->throw_exception ($sqlt->error);
2282 foreach my $db (@$databases) {
2284 $sqlt->{schema} = $sqlt_schema;
2285 $sqlt->producer($db);
2288 my $filename = $schema->ddl_filename($db, $version, $dir);
2289 if (-e $filename && ($version eq $schema_version )) {
2290 # if we are dumping the current version, overwrite the DDL
2291 carp "Overwriting existing DDL file - $filename";
2295 my $output = $sqlt->translate;
2297 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2300 if(!open($file, ">$filename")) {
2301 $self->throw_exception("Can't open $filename for writing ($!)");
2304 print $file $output;
2307 next unless ($preversion);
2309 require SQL::Translator::Diff;
2311 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2312 if(!-e $prefilename) {
2313 carp("No previous schema file found ($prefilename)");
2317 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2319 carp("Overwriting existing diff file - $difffile");
2325 my $t = SQL::Translator->new($sqltargs);
2330 or $self->throw_exception ($t->error);
2332 my $out = $t->translate( $prefilename )
2333 or $self->throw_exception ($t->error);
2335 $source_schema = $t->schema;
2337 $source_schema->name( $prefilename )
2338 unless ( $source_schema->name );
2341 # The "new" style of producers have sane normalization and can support
2342 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2343 # And we have to diff parsed SQL against parsed SQL.
2344 my $dest_schema = $sqlt_schema;
2346 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2347 my $t = SQL::Translator->new($sqltargs);
2352 or $self->throw_exception ($t->error);
2354 my $out = $t->translate( $filename )
2355 or $self->throw_exception ($t->error);
2357 $dest_schema = $t->schema;
2359 $dest_schema->name( $filename )
2360 unless $dest_schema->name;
2363 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2367 if(!open $file, ">$difffile") {
2368 $self->throw_exception("Can't write to $difffile ($!)");
2376 =head2 deployment_statements
2380 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2384 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2386 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2387 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2389 C<$directory> is used to return statements from files in a previously created
2390 L</create_ddl_dir> directory and is optional. The filenames are constructed
2391 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2393 If no C<$directory> is specified then the statements are constructed on the
2394 fly using L<SQL::Translator> and C<$version> is ignored.
2396 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2400 sub deployment_statements {
2401 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2402 $type ||= $self->sqlt_type;
2403 $version ||= $schema->schema_version || '1.x';
2405 my $filename = $schema->ddl_filename($type, $version, $dir);
2409 open($file, "<$filename")
2410 or $self->throw_exception("Can't open $filename ($!)");
2413 return join('', @rows);
2416 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2417 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2420 # sources needs to be a parser arg, but for simplicty allow at top level
2422 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2423 if exists $sqltargs->{sources};
2425 my $tr = SQL::Translator->new(
2426 producer => "SQL::Translator::Producer::${type}",
2428 parser => 'SQL::Translator::Parser::DBIx::Class',
2435 @ret = $tr->translate;
2438 $ret[0] = $tr->translate;
2441 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2442 unless (@ret && defined $ret[0]);
2444 return $wa ? @ret : $ret[0];
2448 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2451 return if($line =~ /^--/);
2453 # next if($line =~ /^DROP/m);
2454 return if($line =~ /^BEGIN TRANSACTION/m);
2455 return if($line =~ /^COMMIT/m);
2456 return if $line =~ /^\s+$/; # skip whitespace only
2457 $self->_query_start($line);
2459 # do a dbh_do cycle here, as we need some error checking in
2460 # place (even though we will ignore errors)
2461 $self->dbh_do (sub { $_[1]->do($line) });
2464 carp qq{$@ (running "${line}")};
2466 $self->_query_end($line);
2468 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2469 if (@statements > 1) {
2470 foreach my $statement (@statements) {
2471 $deploy->( $statement );
2474 elsif (@statements == 1) {
2475 foreach my $line ( split(";\n", $statements[0])) {
2481 =head2 datetime_parser
2483 Returns the datetime parser class
2487 sub datetime_parser {
2489 return $self->{datetime_parser} ||= do {
2490 $self->build_datetime_parser(@_);
2494 =head2 datetime_parser_type
2496 Defines (returns) the datetime parser class - currently hardwired to
2497 L<DateTime::Format::MySQL>
2501 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2503 =head2 build_datetime_parser
2505 See L</datetime_parser>
2509 sub build_datetime_parser {
2511 my $type = $self->datetime_parser_type(@_);
2512 $self->ensure_class_loaded ($type);
2517 =head2 is_replicating
2519 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2520 replicate from a master database. Default is undef, which is the result
2521 returned by databases that don't support replication.
2525 sub is_replicating {
2530 =head2 lag_behind_master
2532 Returns a number that represents a certain amount of lag behind a master db
2533 when a given storage is replicating. The number is database dependent, but
2534 starts at zero and increases with the amount of lag. Default in undef
2538 sub lag_behind_master {
2542 =head2 relname_to_table_alias
2546 =item Arguments: $relname, $join_count
2550 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2553 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2554 way these aliases are named.
2556 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2557 otherwise C<"$relname">.
2561 sub relname_to_table_alias {
2562 my ($self, $relname, $join_count) = @_;
2564 my $alias = ($join_count && $join_count > 1 ?
2565 join('_', $relname, $join_count) : $relname);
2573 $self->_verify_pid if $self->_dbh;
2575 # some databases need this to stop spewing warnings
2576 if (my $dbh = $self->_dbh) {
2579 %{ $dbh->{CachedKids} } = ();
2591 =head2 DBIx::Class and AutoCommit
2593 DBIx::Class can do some wonderful magic with handling exceptions,
2594 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2595 (the default) combined with C<txn_do> for transaction support.
2597 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2598 in an assumed transaction between commits, and you're telling us you'd
2599 like to manage that manually. A lot of the magic protections offered by
2600 this module will go away. We can't protect you from exceptions due to database
2601 disconnects because we don't know anything about how to restart your
2602 transactions. You're on your own for handling all sorts of exceptional
2603 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2609 Matt S. Trout <mst@shadowcatsystems.co.uk>
2611 Andy Grundman <andy@hybridized.org>
2615 You may distribute this code under the same terms as Perl itself.