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 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
956 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
957 if ($self->load_optional_class($storage_class)) {
958 mro::set_mro($storage_class, 'c3');
959 bless $self, $storage_class;
964 $self->_driver_determined(1);
966 $self->_init; # run driver-specific initializations
968 $self->_run_connection_actions
969 if !$started_connected && defined $self->_dbh;
973 sub _do_connection_actions {
975 my $method_prefix = shift;
978 if (not ref($call)) {
979 my $method = $method_prefix . $call;
981 } elsif (ref($call) eq 'CODE') {
983 } elsif (ref($call) eq 'ARRAY') {
984 if (ref($call->[0]) ne 'ARRAY') {
985 $self->_do_connection_actions($method_prefix, $_) for @$call;
987 $self->_do_connection_actions($method_prefix, @$_) for @$call;
990 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
996 sub connect_call_do_sql {
998 $self->_do_query(@_);
1001 sub disconnect_call_do_sql {
1003 $self->_do_query(@_);
1006 # override in db-specific backend when necessary
1007 sub connect_call_datetime_setup { 1 }
1010 my ($self, $action) = @_;
1012 if (ref $action eq 'CODE') {
1013 $action = $action->($self);
1014 $self->_do_query($_) foreach @$action;
1017 # Most debuggers expect ($sql, @bind), so we need to exclude
1018 # the attribute hash which is the second argument to $dbh->do
1019 # furthermore the bind values are usually to be presented
1020 # as named arrayref pairs, so wrap those here too
1021 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1022 my $sql = shift @do_args;
1023 my $attrs = shift @do_args;
1024 my @bind = map { [ undef, $_ ] } @do_args;
1026 $self->_query_start($sql, @bind);
1027 $self->_get_dbh->do($sql, $attrs, @do_args);
1028 $self->_query_end($sql, @bind);
1035 my ($self, @info) = @_;
1037 $self->throw_exception("You failed to provide any connection info")
1040 my ($old_connect_via, $dbh);
1042 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1043 $old_connect_via = $DBI::connect_via;
1044 $DBI::connect_via = 'connect';
1048 if(ref $info[0] eq 'CODE') {
1049 $dbh = $info[0]->();
1052 $dbh = DBI->connect(@info);
1055 if($dbh && !$self->unsafe) {
1056 my $weak_self = $self;
1057 Scalar::Util::weaken($weak_self);
1058 $dbh->{HandleError} = sub {
1060 $weak_self->throw_exception("DBI Exception: $_[0]");
1063 # the handler may be invoked by something totally out of
1065 croak ("DBI Exception: $_[0]");
1068 $dbh->{ShowErrorStatement} = 1;
1069 $dbh->{RaiseError} = 1;
1070 $dbh->{PrintError} = 0;
1074 $DBI::connect_via = $old_connect_via if $old_connect_via;
1076 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1079 $self->_dbh_autocommit($dbh->{AutoCommit});
1085 my ($self, $name) = @_;
1087 $name = $self->_svp_generate_name
1088 unless defined $name;
1090 $self->throw_exception ("You can't use savepoints outside a transaction")
1091 if $self->{transaction_depth} == 0;
1093 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1094 unless $self->can('_svp_begin');
1096 push @{ $self->{savepoints} }, $name;
1098 $self->debugobj->svp_begin($name) if $self->debug;
1100 return $self->_svp_begin($name);
1104 my ($self, $name) = @_;
1106 $self->throw_exception ("You can't use savepoints outside a transaction")
1107 if $self->{transaction_depth} == 0;
1109 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1110 unless $self->can('_svp_release');
1112 if (defined $name) {
1113 $self->throw_exception ("Savepoint '$name' does not exist")
1114 unless grep { $_ eq $name } @{ $self->{savepoints} };
1116 # Dig through the stack until we find the one we are releasing. This keeps
1117 # the stack up to date.
1120 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1122 $name = pop @{ $self->{savepoints} };
1125 $self->debugobj->svp_release($name) if $self->debug;
1127 return $self->_svp_release($name);
1131 my ($self, $name) = @_;
1133 $self->throw_exception ("You can't use savepoints outside a transaction")
1134 if $self->{transaction_depth} == 0;
1136 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1137 unless $self->can('_svp_rollback');
1139 if (defined $name) {
1140 # If they passed us a name, verify that it exists in the stack
1141 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1142 $self->throw_exception("Savepoint '$name' does not exist!");
1145 # Dig through the stack until we find the one we are releasing. This keeps
1146 # the stack up to date.
1147 while(my $s = pop(@{ $self->{savepoints} })) {
1148 last if($s eq $name);
1150 # Add the savepoint back to the stack, as a rollback doesn't remove the
1151 # named savepoint, only everything after it.
1152 push(@{ $self->{savepoints} }, $name);
1154 # We'll assume they want to rollback to the last savepoint
1155 $name = $self->{savepoints}->[-1];
1158 $self->debugobj->svp_rollback($name) if $self->debug;
1160 return $self->_svp_rollback($name);
1163 sub _svp_generate_name {
1166 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1172 # this means we have not yet connected and do not know the AC status
1173 # (e.g. coderef $dbh)
1174 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1176 if($self->{transaction_depth} == 0) {
1177 $self->debugobj->txn_begin()
1179 $self->_dbh_begin_work;
1181 elsif ($self->auto_savepoint) {
1184 $self->{transaction_depth}++;
1187 sub _dbh_begin_work {
1190 # if the user is utilizing txn_do - good for him, otherwise we need to
1191 # ensure that the $dbh is healthy on BEGIN.
1192 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1193 # will be replaced by a failure of begin_work itself (which will be
1194 # then retried on reconnect)
1195 if ($self->{_in_dbh_do}) {
1196 $self->_dbh->begin_work;
1198 $self->dbh_do(sub { $_[1]->begin_work });
1204 if ($self->{transaction_depth} == 1) {
1205 $self->debugobj->txn_commit()
1208 $self->{transaction_depth} = 0
1209 if $self->_dbh_autocommit;
1211 elsif($self->{transaction_depth} > 1) {
1212 $self->{transaction_depth}--;
1214 if $self->auto_savepoint;
1220 my $dbh = $self->_dbh
1221 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1227 my $dbh = $self->_dbh;
1229 if ($self->{transaction_depth} == 1) {
1230 $self->debugobj->txn_rollback()
1232 $self->{transaction_depth} = 0
1233 if $self->_dbh_autocommit;
1234 $self->_dbh_rollback;
1236 elsif($self->{transaction_depth} > 1) {
1237 $self->{transaction_depth}--;
1238 if ($self->auto_savepoint) {
1239 $self->svp_rollback;
1244 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1249 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1250 $error =~ /$exception_class/ and $self->throw_exception($error);
1251 # ensure that a failed rollback resets the transaction depth
1252 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1253 $self->throw_exception($error);
1259 my $dbh = $self->_dbh
1260 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1264 # This used to be the top-half of _execute. It was split out to make it
1265 # easier to override in NoBindVars without duping the rest. It takes up
1266 # all of _execute's args, and emits $sql, @bind.
1267 sub _prep_for_execute {
1268 my ($self, $op, $extra_bind, $ident, $args) = @_;
1270 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1271 $ident = $ident->from();
1274 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1277 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1279 return ($sql, \@bind);
1283 sub _fix_bind_params {
1284 my ($self, @bind) = @_;
1286 ### Turn @bind from something like this:
1287 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1289 ### ( "'1'", "'1'", "'3'" )
1292 if ( defined( $_ && $_->[1] ) ) {
1293 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1300 my ( $self, $sql, @bind ) = @_;
1302 if ( $self->debug ) {
1303 @bind = $self->_fix_bind_params(@bind);
1305 $self->debugobj->query_start( $sql, @bind );
1310 my ( $self, $sql, @bind ) = @_;
1312 if ( $self->debug ) {
1313 @bind = $self->_fix_bind_params(@bind);
1314 $self->debugobj->query_end( $sql, @bind );
1319 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1321 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1323 $self->_query_start( $sql, @$bind );
1325 my $sth = $self->sth($sql,$op);
1327 my $placeholder_index = 1;
1329 foreach my $bound (@$bind) {
1330 my $attributes = {};
1331 my($column_name, @data) = @$bound;
1333 if ($bind_attributes) {
1334 $attributes = $bind_attributes->{$column_name}
1335 if defined $bind_attributes->{$column_name};
1338 foreach my $data (@data) {
1339 my $ref = ref $data;
1340 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1342 $sth->bind_param($placeholder_index, $data, $attributes);
1343 $placeholder_index++;
1347 # Can this fail without throwing an exception anyways???
1348 my $rv = $sth->execute();
1349 $self->throw_exception($sth->errstr) if !$rv;
1351 $self->_query_end( $sql, @$bind );
1353 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1358 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1362 my ($self, $source, $to_insert) = @_;
1364 my $ident = $source->from;
1365 my $bind_attributes = $self->source_bind_attributes($source);
1367 my $updated_cols = {};
1369 foreach my $col ( $source->columns ) {
1370 if ( !defined $to_insert->{$col} ) {
1371 my $col_info = $source->column_info($col);
1373 if ( $col_info->{auto_nextval} ) {
1374 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1376 $col_info->{sequence} ||
1377 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1383 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1385 return $updated_cols;
1388 ## Currently it is assumed that all values passed will be "normal", i.e. not
1389 ## scalar refs, or at least, all the same type as the first set, the statement is
1390 ## only prepped once.
1392 my ($self, $source, $cols, $data) = @_;
1395 @colvalues{@$cols} = (0..$#$cols);
1397 for my $i (0..$#$cols) {
1398 my $first_val = $data->[0][$i];
1399 next unless ref $first_val eq 'SCALAR';
1401 $colvalues{ $cols->[$i] } = $first_val;
1404 # check for bad data and stringify stringifiable objects
1405 my $bad_slice = sub {
1406 my ($msg, $col_idx, $slice_idx) = @_;
1407 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1411 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1412 Data::Dumper::Concise::Dumper({
1413 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1419 for my $datum_idx (0..$#$data) {
1420 my $datum = $data->[$datum_idx];
1422 for my $col_idx (0..$#$cols) {
1423 my $val = $datum->[$col_idx];
1424 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1425 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1427 if ($is_literal_sql) {
1429 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1431 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1432 $bad_slice->("$reftype reference found where literal SQL expected",
1433 $col_idx, $datum_idx);
1435 elsif ($$val ne $$sqla_bind){
1436 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1437 $col_idx, $datum_idx);
1440 elsif (my $reftype = ref $val) {
1442 if (overload::Method($val, '""')) {
1443 $datum->[$col_idx] = "".$val;
1446 $bad_slice->("$reftype reference found where bind expected",
1447 $col_idx, $datum_idx);
1453 my ($sql, $bind) = $self->_prep_for_execute (
1454 'insert', undef, $source, [\%colvalues]
1458 my $empty_bind = 1 if (not @bind) &&
1459 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1461 if ((not @bind) && (not $empty_bind)) {
1462 $self->throw_exception(
1463 'Cannot insert_bulk without support for placeholders'
1467 # neither _execute_array, nor _execute_inserts_with_no_binds are
1468 # atomic (even if _execute _array is a single call). Thus a safety
1470 my $guard = $self->txn_scope_guard unless $self->{transaction_depth} != 0;
1472 $self->_query_start( $sql, ['__BULK__'] );
1473 my $sth = $self->sth($sql);
1476 # bind_param_array doesn't work if there are no binds
1477 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1480 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1481 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1485 $self->_query_end( $sql, ['__BULK__'] );
1488 $guard->commit if $guard;
1490 return (wantarray ? ($rv, $sth, @bind) : $rv);
1493 sub _execute_array {
1494 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1496 ## This must be an arrayref, else nothing works!
1497 my $tuple_status = [];
1499 ## Get the bind_attributes, if any exist
1500 my $bind_attributes = $self->source_bind_attributes($source);
1502 ## Bind the values and execute
1503 my $placeholder_index = 1;
1505 foreach my $bound (@$bind) {
1507 my $attributes = {};
1508 my ($column_name, $data_index) = @$bound;
1510 if( $bind_attributes ) {
1511 $attributes = $bind_attributes->{$column_name}
1512 if defined $bind_attributes->{$column_name};
1515 my @data = map { $_->[$data_index] } @$data;
1517 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1518 $placeholder_index++;
1522 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1524 my $err = $@ || $sth->errstr;
1526 # Statement must finish even if there was an exception.
1527 eval { $sth->finish };
1528 $err = $@ unless $err;
1532 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1534 $self->throw_exception("Unexpected populate error: $err")
1535 if ($i > $#$tuple_status);
1537 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1538 ($tuple_status->[$i][1] || $err),
1539 Data::Dumper::Concise::Dumper({
1540 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1547 sub _dbh_execute_array {
1548 my ($self, $sth, $tuple_status, @extra) = @_;
1550 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1553 sub _dbh_execute_inserts_with_no_binds {
1554 my ($self, $sth, $count) = @_;
1557 my $dbh = $self->_get_dbh;
1558 local $dbh->{RaiseError} = 1;
1559 local $dbh->{PrintError} = 0;
1561 $sth->execute foreach 1..$count;
1565 # Make sure statement is finished even if there was an exception.
1566 eval { $sth->finish };
1567 $exception = $@ unless $exception;
1569 $self->throw_exception($exception) if $exception;
1575 my ($self, $source, @args) = @_;
1577 my $bind_attrs = $self->source_bind_attributes($source);
1579 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1584 my ($self, $source, @args) = @_;
1586 my $bind_attrs = $self->source_bind_attributes($source);
1588 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1591 # We were sent here because the $rs contains a complex search
1592 # which will require a subquery to select the correct rows
1593 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1595 # Generating a single PK column subquery is trivial and supported
1596 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1597 # Look at _multipk_update_delete()
1598 sub _subq_update_delete {
1600 my ($rs, $op, $values) = @_;
1602 my $rsrc = $rs->result_source;
1604 # quick check if we got a sane rs on our hands
1605 my @pcols = $rsrc->_pri_cols;
1607 my $sel = $rs->_resolved_attrs->{select};
1608 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1611 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1613 join ("\x00", sort @$sel )
1615 $self->throw_exception (
1616 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1623 $op eq 'update' ? $values : (),
1624 { $pcols[0] => { -in => $rs->as_query } },
1629 return $self->_multipk_update_delete (@_);
1633 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1634 # resultset update/delete involving subqueries. So by default resort
1635 # to simple (and inefficient) delete_all style per-row opearations,
1636 # while allowing specific storages to override this with a faster
1639 sub _multipk_update_delete {
1640 return shift->_per_row_update_delete (@_);
1643 # This is the default loop used to delete/update rows for multi PK
1644 # resultsets, and used by mysql exclusively (because it can't do anything
1647 # We do not use $row->$op style queries, because resultset update/delete
1648 # is not expected to cascade (this is what delete_all/update_all is for).
1650 # There should be no race conditions as the entire operation is rolled
1653 sub _per_row_update_delete {
1655 my ($rs, $op, $values) = @_;
1657 my $rsrc = $rs->result_source;
1658 my @pcols = $rsrc->_pri_cols;
1660 my $guard = $self->txn_scope_guard;
1662 # emulate the return value of $sth->execute for non-selects
1663 my $row_cnt = '0E0';
1665 my $subrs_cur = $rs->cursor;
1666 my @all_pk = $subrs_cur->all;
1667 for my $pks ( @all_pk) {
1670 for my $i (0.. $#pcols) {
1671 $cond->{$pcols[$i]} = $pks->[$i];
1676 $op eq 'update' ? $values : (),
1691 # localization is neccessary as
1692 # 1) there is no infrastructure to pass this around before SQLA2
1693 # 2) _select_args sets it and _prep_for_execute consumes it
1694 my $sql_maker = $self->sql_maker;
1695 local $sql_maker->{_dbic_rs_attrs};
1697 return $self->_execute($self->_select_args(@_));
1700 sub _select_args_to_query {
1703 # localization is neccessary as
1704 # 1) there is no infrastructure to pass this around before SQLA2
1705 # 2) _select_args sets it and _prep_for_execute consumes it
1706 my $sql_maker = $self->sql_maker;
1707 local $sql_maker->{_dbic_rs_attrs};
1709 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1710 # = $self->_select_args($ident, $select, $cond, $attrs);
1711 my ($op, $bind, $ident, $bind_attrs, @args) =
1712 $self->_select_args(@_);
1714 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1715 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1716 $prepared_bind ||= [];
1719 ? ($sql, $prepared_bind, $bind_attrs)
1720 : \[ "($sql)", @$prepared_bind ]
1725 my ($self, $ident, $select, $where, $attrs) = @_;
1727 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1729 my $sql_maker = $self->sql_maker;
1730 $sql_maker->{_dbic_rs_attrs} = {
1735 $rs_alias && $alias2source->{$rs_alias}
1736 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1741 # calculate bind_attrs before possible $ident mangling
1742 my $bind_attrs = {};
1743 for my $alias (keys %$alias2source) {
1744 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1745 for my $col (keys %$bindtypes) {
1747 my $fqcn = join ('.', $alias, $col);
1748 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1750 # Unqialified column names are nice, but at the same time can be
1751 # rather ambiguous. What we do here is basically go along with
1752 # the loop, adding an unqualified column slot to $bind_attrs,
1753 # alongside the fully qualified name. As soon as we encounter
1754 # another column by that name (which would imply another table)
1755 # we unset the unqualified slot and never add any info to it
1756 # to avoid erroneous type binding. If this happens the users
1757 # only choice will be to fully qualify his column name
1759 if (exists $bind_attrs->{$col}) {
1760 $bind_attrs->{$col} = {};
1763 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1770 $attrs->{software_limit}
1772 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1774 $attrs->{software_limit} = 1;
1777 $self->throw_exception("rows attribute must be positive if present")
1778 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1780 # MySQL actually recommends this approach. I cringe.
1781 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1786 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1787 # storage, unless software limit was requested
1790 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1792 # limited prefetch with RNO subqueries
1796 $sql_maker->limit_dialect eq 'RowNumberOver'
1798 $attrs->{_prefetch_select}
1800 @{$attrs->{_prefetch_select}}
1804 ( $attrs->{group_by}
1806 @{$attrs->{group_by}}
1808 $attrs->{_prefetch_select}
1810 @{$attrs->{_prefetch_select}}
1813 ($ident, $select, $where, $attrs)
1814 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1818 ($attrs->{rows} || $attrs->{offset})
1820 $sql_maker->limit_dialect eq 'RowNumberOver'
1822 (ref $ident eq 'ARRAY' && @$ident > 1) # indicates a join
1824 scalar $self->_parse_order_by ($attrs->{order_by})
1826 # the RNO limit dialect above mangles the SQL such that the join gets lost
1827 # wrap a subquery here
1829 push @limit, delete @{$attrs}{qw/rows offset/};
1831 my $subq = $self->_select_args_to_query (
1839 -alias => $attrs->{alias},
1840 -source_handle => $ident->[0]{-source_handle},
1841 $attrs->{alias} => $subq,
1844 # all part of the subquery now
1845 delete @{$attrs}{qw/order_by group_by having/};
1849 elsif (! $attrs->{software_limit} ) {
1850 push @limit, $attrs->{rows}, $attrs->{offset};
1853 # try to simplify the joinmap further (prune unreferenced type-single joins)
1854 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1857 # This would be the point to deflate anything found in $where
1858 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1859 # expect a row object. And all we have is a resultsource (it is trivial
1860 # to extract deflator coderefs via $alias2source above).
1862 # I don't see a way forward other than changing the way deflators are
1863 # invoked, and that's just bad...
1867 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1868 (qw/order_by group_by having/ )
1871 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1874 # Returns a counting SELECT for a simple count
1875 # query. Abstracted so that a storage could override
1876 # this to { count => 'firstcol' } or whatever makes
1877 # sense as a performance optimization
1879 #my ($self, $source, $rs_attrs) = @_;
1880 return { count => '*' };
1883 # Returns a SELECT which will end up in the subselect
1884 # There may or may not be a group_by, as the subquery
1885 # might have been called to accomodate a limit
1887 # Most databases would be happy with whatever ends up
1888 # here, but some choke in various ways.
1890 sub _subq_count_select {
1891 my ($self, $source, $rs_attrs) = @_;
1893 if (my $groupby = $rs_attrs->{group_by}) {
1895 my $avail_columns = $self->_resolve_column_info ($rs_attrs->{from});
1898 for my $sel (@{$rs_attrs->{select}}) {
1899 if (ref $sel eq 'HASH' and $sel->{-as}) {
1900 $sel_index->{$sel->{-as}} = $sel;
1905 for my $g_part (@$groupby) {
1906 if (ref $g_part or $avail_columns->{$g_part}) {
1907 push @selection, $g_part;
1909 elsif ($sel_index->{$g_part}) {
1910 push @selection, $sel_index->{$g_part};
1913 $self->throw_exception ("group_by criteria '$g_part' not contained within current resultset source(s)");
1920 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1921 return @pcols ? \@pcols : [ 1 ];
1924 sub source_bind_attributes {
1925 my ($self, $source) = @_;
1927 my $bind_attributes;
1928 foreach my $column ($source->columns) {
1930 my $data_type = $source->column_info($column)->{data_type} || '';
1931 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1935 return $bind_attributes;
1942 =item Arguments: $ident, $select, $condition, $attrs
1946 Handle a SQL select statement.
1952 my ($ident, $select, $condition, $attrs) = @_;
1953 return $self->cursor_class->new($self, \@_, $attrs);
1958 my ($rv, $sth, @bind) = $self->_select(@_);
1959 my @row = $sth->fetchrow_array;
1960 my @nextrow = $sth->fetchrow_array if @row;
1961 if(@row && @nextrow) {
1962 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1964 # Need to call finish() to work round broken DBDs
1973 =item Arguments: $sql
1977 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1982 my ($self, $dbh, $sql) = @_;
1984 # 3 is the if_active parameter which avoids active sth re-use
1985 my $sth = $self->disable_sth_caching
1986 ? $dbh->prepare($sql)
1987 : $dbh->prepare_cached($sql, {}, 3);
1989 # XXX You would think RaiseError would make this impossible,
1990 # but apparently that's not true :(
1991 $self->throw_exception($dbh->errstr) if !$sth;
1997 my ($self, $sql) = @_;
1998 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2001 sub _dbh_columns_info_for {
2002 my ($self, $dbh, $table) = @_;
2004 if ($dbh->can('column_info')) {
2007 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2008 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2010 while ( my $info = $sth->fetchrow_hashref() ){
2012 $column_info{data_type} = $info->{TYPE_NAME};
2013 $column_info{size} = $info->{COLUMN_SIZE};
2014 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2015 $column_info{default_value} = $info->{COLUMN_DEF};
2016 my $col_name = $info->{COLUMN_NAME};
2017 $col_name =~ s/^\"(.*)\"$/$1/;
2019 $result{$col_name} = \%column_info;
2022 return \%result if !$@ && scalar keys %result;
2026 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2028 my @columns = @{$sth->{NAME_lc}};
2029 for my $i ( 0 .. $#columns ){
2031 $column_info{data_type} = $sth->{TYPE}->[$i];
2032 $column_info{size} = $sth->{PRECISION}->[$i];
2033 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2035 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2036 $column_info{data_type} = $1;
2037 $column_info{size} = $2;
2040 $result{$columns[$i]} = \%column_info;
2044 foreach my $col (keys %result) {
2045 my $colinfo = $result{$col};
2046 my $type_num = $colinfo->{data_type};
2048 if(defined $type_num && $dbh->can('type_info')) {
2049 my $type_info = $dbh->type_info($type_num);
2050 $type_name = $type_info->{TYPE_NAME} if $type_info;
2051 $colinfo->{data_type} = $type_name if $type_name;
2058 sub columns_info_for {
2059 my ($self, $table) = @_;
2060 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2063 =head2 last_insert_id
2065 Return the row id of the last insert.
2069 sub _dbh_last_insert_id {
2070 my ($self, $dbh, $source, $col) = @_;
2072 my $id = eval { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2074 return $id if defined $id;
2076 my $class = ref $self;
2077 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2080 sub last_insert_id {
2082 $self->_dbh_last_insert_id ($self->_dbh, @_);
2085 =head2 _native_data_type
2089 =item Arguments: $type_name
2093 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2094 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2095 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2097 The default implementation returns C<undef>, implement in your Storage driver if
2098 you need this functionality.
2100 Should map types from other databases to the native RDBMS type, for example
2101 C<VARCHAR2> to C<VARCHAR>.
2103 Types with modifiers should map to the underlying data type. For example,
2104 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2106 Composite types should map to the container type, for example
2107 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2111 sub _native_data_type {
2112 #my ($self, $data_type) = @_;
2116 # Check if placeholders are supported at all
2117 sub _placeholders_supported {
2119 my $dbh = $self->_get_dbh;
2121 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2122 # but it is inaccurate more often than not
2124 local $dbh->{PrintError} = 0;
2125 local $dbh->{RaiseError} = 1;
2126 $dbh->do('select ?', {}, 1);
2131 # Check if placeholders bound to non-string types throw exceptions
2133 sub _typeless_placeholders_supported {
2135 my $dbh = $self->_get_dbh;
2138 local $dbh->{PrintError} = 0;
2139 local $dbh->{RaiseError} = 1;
2140 # this specifically tests a bind that is NOT a string
2141 $dbh->do('select 1 where 1 = ?', {}, 1);
2148 Returns the database driver name.
2153 shift->_get_dbh->{Driver}->{Name};
2156 =head2 bind_attribute_by_data_type
2158 Given a datatype from column info, returns a database specific bind
2159 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2160 let the database planner just handle it.
2162 Generally only needed for special case column types, like bytea in postgres.
2166 sub bind_attribute_by_data_type {
2170 =head2 is_datatype_numeric
2172 Given a datatype from column_info, returns a boolean value indicating if
2173 the current RDBMS considers it a numeric value. This controls how
2174 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2175 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2176 be performed instead of the usual C<eq>.
2180 sub is_datatype_numeric {
2181 my ($self, $dt) = @_;
2183 return 0 unless $dt;
2185 return $dt =~ /^ (?:
2186 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2191 =head2 create_ddl_dir
2195 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2199 Creates a SQL file based on the Schema, for each of the specified
2200 database engines in C<\@databases> in the given directory.
2201 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2203 Given a previous version number, this will also create a file containing
2204 the ALTER TABLE statements to transform the previous schema into the
2205 current one. Note that these statements may contain C<DROP TABLE> or
2206 C<DROP COLUMN> statements that can potentially destroy data.
2208 The file names are created using the C<ddl_filename> method below, please
2209 override this method in your schema if you would like a different file
2210 name format. For the ALTER file, the same format is used, replacing
2211 $version in the name with "$preversion-$version".
2213 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2214 The most common value for this would be C<< { add_drop_table => 1 } >>
2215 to have the SQL produced include a C<DROP TABLE> statement for each table
2216 created. For quoting purposes supply C<quote_table_names> and
2217 C<quote_field_names>.
2219 If no arguments are passed, then the following default values are assumed:
2223 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2225 =item version - $schema->schema_version
2227 =item directory - './'
2229 =item preversion - <none>
2233 By default, C<\%sqlt_args> will have
2235 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2237 merged with the hash passed in. To disable any of those features, pass in a
2238 hashref like the following
2240 { ignore_constraint_names => 0, # ... other options }
2243 WARNING: You are strongly advised to check all SQL files created, before applying
2248 sub create_ddl_dir {
2249 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2251 if(!$dir || !-d $dir) {
2252 carp "No directory given, using ./\n";
2255 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2256 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2258 my $schema_version = $schema->schema_version || '1.x';
2259 $version ||= $schema_version;
2262 add_drop_table => 1,
2263 ignore_constraint_names => 1,
2264 ignore_index_names => 1,
2268 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2269 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2272 my $sqlt = SQL::Translator->new( $sqltargs );
2274 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2275 my $sqlt_schema = $sqlt->translate({ data => $schema })
2276 or $self->throw_exception ($sqlt->error);
2278 foreach my $db (@$databases) {
2280 $sqlt->{schema} = $sqlt_schema;
2281 $sqlt->producer($db);
2284 my $filename = $schema->ddl_filename($db, $version, $dir);
2285 if (-e $filename && ($version eq $schema_version )) {
2286 # if we are dumping the current version, overwrite the DDL
2287 carp "Overwriting existing DDL file - $filename";
2291 my $output = $sqlt->translate;
2293 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2296 if(!open($file, ">$filename")) {
2297 $self->throw_exception("Can't open $filename for writing ($!)");
2300 print $file $output;
2303 next unless ($preversion);
2305 require SQL::Translator::Diff;
2307 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2308 if(!-e $prefilename) {
2309 carp("No previous schema file found ($prefilename)");
2313 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2315 carp("Overwriting existing diff file - $difffile");
2321 my $t = SQL::Translator->new($sqltargs);
2326 or $self->throw_exception ($t->error);
2328 my $out = $t->translate( $prefilename )
2329 or $self->throw_exception ($t->error);
2331 $source_schema = $t->schema;
2333 $source_schema->name( $prefilename )
2334 unless ( $source_schema->name );
2337 # The "new" style of producers have sane normalization and can support
2338 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2339 # And we have to diff parsed SQL against parsed SQL.
2340 my $dest_schema = $sqlt_schema;
2342 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2343 my $t = SQL::Translator->new($sqltargs);
2348 or $self->throw_exception ($t->error);
2350 my $out = $t->translate( $filename )
2351 or $self->throw_exception ($t->error);
2353 $dest_schema = $t->schema;
2355 $dest_schema->name( $filename )
2356 unless $dest_schema->name;
2359 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2363 if(!open $file, ">$difffile") {
2364 $self->throw_exception("Can't write to $difffile ($!)");
2372 =head2 deployment_statements
2376 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2380 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2382 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2383 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2385 C<$directory> is used to return statements from files in a previously created
2386 L</create_ddl_dir> directory and is optional. The filenames are constructed
2387 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2389 If no C<$directory> is specified then the statements are constructed on the
2390 fly using L<SQL::Translator> and C<$version> is ignored.
2392 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2396 sub deployment_statements {
2397 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2398 $type ||= $self->sqlt_type;
2399 $version ||= $schema->schema_version || '1.x';
2401 my $filename = $schema->ddl_filename($type, $version, $dir);
2405 open($file, "<$filename")
2406 or $self->throw_exception("Can't open $filename ($!)");
2409 return join('', @rows);
2412 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2413 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2416 # sources needs to be a parser arg, but for simplicty allow at top level
2418 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2419 if exists $sqltargs->{sources};
2421 my $tr = SQL::Translator->new(
2422 producer => "SQL::Translator::Producer::${type}",
2424 parser => 'SQL::Translator::Parser::DBIx::Class',
2431 @ret = $tr->translate;
2434 $ret[0] = $tr->translate;
2437 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2438 unless (@ret && defined $ret[0]);
2440 return $wa ? @ret : $ret[0];
2444 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2447 return if($line =~ /^--/);
2449 # next if($line =~ /^DROP/m);
2450 return if($line =~ /^BEGIN TRANSACTION/m);
2451 return if($line =~ /^COMMIT/m);
2452 return if $line =~ /^\s+$/; # skip whitespace only
2453 $self->_query_start($line);
2455 # do a dbh_do cycle here, as we need some error checking in
2456 # place (even though we will ignore errors)
2457 $self->dbh_do (sub { $_[1]->do($line) });
2460 carp qq{$@ (running "${line}")};
2462 $self->_query_end($line);
2464 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2465 if (@statements > 1) {
2466 foreach my $statement (@statements) {
2467 $deploy->( $statement );
2470 elsif (@statements == 1) {
2471 foreach my $line ( split(";\n", $statements[0])) {
2477 =head2 datetime_parser
2479 Returns the datetime parser class
2483 sub datetime_parser {
2485 return $self->{datetime_parser} ||= do {
2486 $self->build_datetime_parser(@_);
2490 =head2 datetime_parser_type
2492 Defines (returns) the datetime parser class - currently hardwired to
2493 L<DateTime::Format::MySQL>
2497 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2499 =head2 build_datetime_parser
2501 See L</datetime_parser>
2505 sub build_datetime_parser {
2507 my $type = $self->datetime_parser_type(@_);
2508 $self->ensure_class_loaded ($type);
2513 =head2 is_replicating
2515 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2516 replicate from a master database. Default is undef, which is the result
2517 returned by databases that don't support replication.
2521 sub is_replicating {
2526 =head2 lag_behind_master
2528 Returns a number that represents a certain amount of lag behind a master db
2529 when a given storage is replicating. The number is database dependent, but
2530 starts at zero and increases with the amount of lag. Default in undef
2534 sub lag_behind_master {
2538 =head2 relname_to_table_alias
2542 =item Arguments: $relname, $join_count
2546 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2549 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2550 way these aliases are named.
2552 The default behavior is C<"$relname_$join_count" if $join_count > 1>, otherwise
2557 sub relname_to_table_alias {
2558 my ($self, $relname, $join_count) = @_;
2560 my $alias = ($join_count && $join_count > 1 ?
2561 join('_', $relname, $join_count) : $relname);
2569 $self->_verify_pid if $self->_dbh;
2571 # some databases need this to stop spewing warnings
2572 if (my $dbh = $self->_dbh) {
2575 %{ $dbh->{CachedKids} } = ();
2587 =head2 DBIx::Class and AutoCommit
2589 DBIx::Class can do some wonderful magic with handling exceptions,
2590 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2591 (the default) combined with C<txn_do> for transaction support.
2593 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2594 in an assumed transaction between commits, and you're telling us you'd
2595 like to manage that manually. A lot of the magic protections offered by
2596 this module will go away. We can't protect you from exceptions due to database
2597 disconnects because we don't know anything about how to restart your
2598 transactions. You're on your own for handling all sorts of exceptional
2599 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2605 Matt S. Trout <mst@shadowcatsystems.co.uk>
2607 Andy Grundman <andy@hybridized.org>
2611 You may distribute this code under the same terms as Perl itself.