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 # what version of sqlt do we require if deploy() without a ddl_dir is invoked
20 # when changing also adjust the corresponding author_require in Makefile.PL
21 my $minimum_sqlt_version = '0.11002';
24 __PACKAGE__->mk_group_accessors('simple' =>
25 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
26 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints/
29 # the values for these accessors are picked out (and deleted) from
30 # the attribute hashref passed to connect_info
31 my @storage_options = qw/
32 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
33 disable_sth_caching unsafe auto_savepoint
35 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
38 # default cursor class, overridable in connect_info attributes
39 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
41 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
42 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
45 # Each of these methods need _determine_driver called before itself
46 # in order to function reliably. This is a purely DRY optimization
47 my @rdbms_specific_methods = qw/
60 for my $meth (@rdbms_specific_methods) {
62 my $orig = __PACKAGE__->can ($meth)
66 no warnings qw/redefine/;
67 *{__PACKAGE__ ."::$meth"} = Sub::Name::subname $meth => sub {
68 if (not $_[0]->_driver_determined) {
69 $_[0]->_determine_driver;
70 goto $_[0]->can($meth);
79 DBIx::Class::Storage::DBI - DBI storage handler
83 my $schema = MySchema->connect('dbi:SQLite:my.db');
85 $schema->storage->debug(1);
87 my @stuff = $schema->storage->dbh_do(
89 my ($storage, $dbh, @args) = @_;
90 $dbh->do("DROP TABLE authors");
95 $schema->resultset('Book')->search({
96 written_on => $schema->storage->datetime_parser(DateTime->now)
101 This class represents the connection to an RDBMS via L<DBI>. See
102 L<DBIx::Class::Storage> for general information. This pod only
103 documents DBI-specific methods and behaviors.
110 my $new = shift->next::method(@_);
112 $new->transaction_depth(0);
113 $new->_sql_maker_opts({});
114 $new->{savepoints} = [];
115 $new->{_in_dbh_do} = 0;
116 $new->{_dbh_gen} = 0;
123 This method is normally called by L<DBIx::Class::Schema/connection>, which
124 encapsulates its argument list in an arrayref before passing them here.
126 The argument list may contain:
132 The same 4-element argument set one would normally pass to
133 L<DBI/connect>, optionally followed by
134 L<extra attributes|/DBIx::Class specific connection attributes>
135 recognized by DBIx::Class:
137 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
141 A single code reference which returns a connected
142 L<DBI database handle|DBI/connect> optionally followed by
143 L<extra attributes|/DBIx::Class specific connection attributes> recognized
146 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
150 A single hashref with all the attributes and the dsn/user/password
153 $connect_info_args = [{
161 $connect_info_args = [{
162 dbh_maker => sub { DBI->connect (...) },
167 This is particularly useful for L<Catalyst> based applications, allowing the
168 following config (L<Config::General> style):
173 dsn dbi:mysql:database=test
180 The C<dsn>/C<user>/C<password> combination can be substituted by the
181 C<dbh_maker> key whose value is a coderef that returns a connected
182 L<DBI database handle|DBI/connect>
186 Please note that the L<DBI> docs recommend that you always explicitly
187 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
188 recommends that it be set to I<1>, and that you perform transactions
189 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
190 to I<1> if you do not do explicitly set it to zero. This is the default
191 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
193 =head3 DBIx::Class specific connection attributes
195 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
196 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
197 the following connection options. These options can be mixed in with your other
198 L<DBI> connection attributes, or placed in a seperate hashref
199 (C<\%extra_attributes>) as shown above.
201 Every time C<connect_info> is invoked, any previous settings for
202 these options will be cleared before setting the new ones, regardless of
203 whether any options are specified in the new C<connect_info>.
210 Specifies things to do immediately after connecting or re-connecting to
211 the database. Its value may contain:
217 This contains one SQL statement to execute.
219 =item an array reference
221 This contains SQL statements to execute in order. Each element contains
222 a string or a code reference that returns a string.
224 =item a code reference
226 This contains some code to execute. Unlike code references within an
227 array reference, its return value is ignored.
231 =item on_disconnect_do
233 Takes arguments in the same form as L</on_connect_do> and executes them
234 immediately before disconnecting from the database.
236 Note, this only runs if you explicitly call L</disconnect> on the
239 =item on_connect_call
241 A more generalized form of L</on_connect_do> that calls the specified
242 C<connect_call_METHOD> methods in your storage driver.
244 on_connect_do => 'select 1'
248 on_connect_call => [ [ do_sql => 'select 1' ] ]
250 Its values may contain:
256 Will call the C<connect_call_METHOD> method.
258 =item a code reference
260 Will execute C<< $code->($storage) >>
262 =item an array reference
264 Each value can be a method name or code reference.
266 =item an array of arrays
268 For each array, the first item is taken to be the C<connect_call_> method name
269 or code reference, and the rest are parameters to it.
273 Some predefined storage methods you may use:
279 Executes a SQL string or a code reference that returns a SQL string. This is
280 what L</on_connect_do> and L</on_disconnect_do> use.
288 Will execute the scalar as SQL.
292 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
293 attributes hashref and bind values.
295 =item a code reference
297 Will execute C<< $code->($storage) >> and execute the return array refs as
304 Execute any statements necessary to initialize the database session to return
305 and accept datetime/timestamp values used with
306 L<DBIx::Class::InflateColumn::DateTime>.
308 Only necessary for some databases, see your specific storage driver for
309 implementation details.
313 =item on_disconnect_call
315 Takes arguments in the same form as L</on_connect_call> and executes them
316 immediately before disconnecting from the database.
318 Calls the C<disconnect_call_METHOD> methods as opposed to the
319 C<connect_call_METHOD> methods called by L</on_connect_call>.
321 Note, this only runs if you explicitly call L</disconnect> on the
324 =item disable_sth_caching
326 If set to a true value, this option will disable the caching of
327 statement handles via L<DBI/prepare_cached>.
331 Sets the limit dialect. This is useful for JDBC-bridge among others
332 where the remote SQL-dialect cannot be determined by the name of the
333 driver alone. See also L<SQL::Abstract::Limit>.
337 Specifies what characters to use to quote table and column names. If
338 you use this you will want to specify L</name_sep> as well.
340 C<quote_char> expects either a single character, in which case is it
341 is placed on either side of the table/column name, or an arrayref of length
342 2 in which case the table/column name is placed between the elements.
344 For example under MySQL you should use C<< quote_char => '`' >>, and for
345 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
349 This only needs to be used in conjunction with C<quote_char>, and is used to
350 specify the charecter that seperates elements (schemas, tables, columns) from
351 each other. In most cases this is simply a C<.>.
353 The consequences of not supplying this value is that L<SQL::Abstract>
354 will assume DBIx::Class' uses of aliases to be complete column
355 names. The output will look like I<"me.name"> when it should actually
360 This Storage driver normally installs its own C<HandleError>, sets
361 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
362 all database handles, including those supplied by a coderef. It does this
363 so that it can have consistent and useful error behavior.
365 If you set this option to a true value, Storage will not do its usual
366 modifications to the database handle's attributes, and instead relies on
367 the settings in your connect_info DBI options (or the values you set in
368 your connection coderef, in the case that you are connecting via coderef).
370 Note that your custom settings can cause Storage to malfunction,
371 especially if you set a C<HandleError> handler that suppresses exceptions
372 and/or disable C<RaiseError>.
376 If this option is true, L<DBIx::Class> will use savepoints when nesting
377 transactions, making it possible to recover from failure in the inner
378 transaction without having to abort all outer transactions.
382 Use this argument to supply a cursor class other than the default
383 L<DBIx::Class::Storage::DBI::Cursor>.
387 Some real-life examples of arguments to L</connect_info> and
388 L<DBIx::Class::Schema/connect>
390 # Simple SQLite connection
391 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
394 ->connect_info([ sub { DBI->connect(...) } ]);
396 # Connect via subref in hashref
398 dbh_maker => sub { DBI->connect(...) },
399 on_connect_do => 'alter session ...',
402 # A bit more complicated
409 { quote_char => q{"}, name_sep => q{.} },
413 # Equivalent to the previous example
419 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
423 # Same, but with hashref as argument
424 # See parse_connect_info for explanation
427 dsn => 'dbi:Pg:dbname=foo',
429 password => 'my_pg_password',
436 # Subref + DBIx::Class-specific connection options
439 sub { DBI->connect(...) },
443 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
444 disable_sth_caching => 1,
454 my ($self, $info) = @_;
456 return $self->_connect_info if !$info;
458 $self->_connect_info($info); # copy for _connect_info
460 $info = $self->_normalize_connect_info($info)
461 if ref $info eq 'ARRAY';
463 for my $storage_opt (keys %{ $info->{storage_options} }) {
464 my $value = $info->{storage_options}{$storage_opt};
466 $self->$storage_opt($value);
469 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
470 # the new set of options
471 $self->_sql_maker(undef);
472 $self->_sql_maker_opts({});
474 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
475 my $value = $info->{sql_maker_options}{$sql_maker_opt};
477 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
481 %{ $self->_default_dbi_connect_attributes || {} },
482 %{ $info->{attributes} || {} },
485 my @args = @{ $info->{arguments} };
487 $self->_dbi_connect_info([@args,
488 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
490 return $self->_connect_info;
493 sub _normalize_connect_info {
494 my ($self, $info_arg) = @_;
497 my @args = @$info_arg; # take a shallow copy for further mutilation
499 # combine/pre-parse arguments depending on invocation style
502 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
503 %attrs = %{ $args[1] || {} };
506 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
507 %attrs = %{$args[0]};
509 if (my $code = delete $attrs{dbh_maker}) {
512 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
515 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
516 . "to the result of 'dbh_maker'",
518 join (', ', map { "'$_'" } (@ignored) ),
523 @args = delete @attrs{qw/dsn user password/};
526 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
528 % { $args[3] || {} },
529 % { $args[4] || {} },
531 @args = @args[0,1,2];
534 $info{arguments} = \@args;
536 my @storage_opts = grep exists $attrs{$_},
537 @storage_options, 'cursor_class';
539 @{ $info{storage_options} }{@storage_opts} =
540 delete @attrs{@storage_opts} if @storage_opts;
542 my @sql_maker_opts = grep exists $attrs{$_},
543 qw/limit_dialect quote_char name_sep/;
545 @{ $info{sql_maker_options} }{@sql_maker_opts} =
546 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
548 $info{attributes} = \%attrs if %attrs;
553 sub _default_dbi_connect_attributes {
563 This method is deprecated in favour of setting via L</connect_info>.
567 =head2 on_disconnect_do
569 This method is deprecated in favour of setting via L</connect_info>.
573 sub _parse_connect_do {
574 my ($self, $type) = @_;
576 my $val = $self->$type;
577 return () if not defined $val;
582 push @res, [ 'do_sql', $val ];
583 } elsif (ref($val) eq 'CODE') {
585 } elsif (ref($val) eq 'ARRAY') {
586 push @res, map { [ 'do_sql', $_ ] } @$val;
588 $self->throw_exception("Invalid type for $type: ".ref($val));
596 Arguments: ($subref | $method_name), @extra_coderef_args?
598 Execute the given $subref or $method_name using the new exception-based
599 connection management.
601 The first two arguments will be the storage object that C<dbh_do> was called
602 on and a database handle to use. Any additional arguments will be passed
603 verbatim to the called subref as arguments 2 and onwards.
605 Using this (instead of $self->_dbh or $self->dbh) ensures correct
606 exception handling and reconnection (or failover in future subclasses).
608 Your subref should have no side-effects outside of the database, as
609 there is the potential for your subref to be partially double-executed
610 if the database connection was stale/dysfunctional.
614 my @stuff = $schema->storage->dbh_do(
616 my ($storage, $dbh, @cols) = @_;
617 my $cols = join(q{, }, @cols);
618 $dbh->selectrow_array("SELECT $cols FROM foo");
629 my $dbh = $self->_get_dbh;
631 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
632 || $self->{transaction_depth};
634 local $self->{_in_dbh_do} = 1;
637 my $want_array = wantarray;
642 @result = $self->$code($dbh, @_);
644 elsif(defined $want_array) {
645 $result[0] = $self->$code($dbh, @_);
648 $self->$code($dbh, @_);
652 # ->connected might unset $@ - copy
654 if(!$exception) { return $want_array ? @result : $result[0] }
656 $self->throw_exception($exception) if $self->connected;
658 # We were not connected - reconnect and retry, but let any
659 # exception fall right through this time
660 carp "Retrying $code after catching disconnected exception: $exception"
661 if $ENV{DBIC_DBIRETRY_DEBUG};
662 $self->_populate_dbh;
663 $self->$code($self->_dbh, @_);
666 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
667 # It also informs dbh_do to bypass itself while under the direction of txn_do,
668 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
673 ref $coderef eq 'CODE' or $self->throw_exception
674 ('$coderef must be a CODE reference');
676 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
678 local $self->{_in_dbh_do} = 1;
681 my $want_array = wantarray;
690 @result = $coderef->(@_);
692 elsif(defined $want_array) {
693 $result[0] = $coderef->(@_);
701 # ->connected might unset $@ - copy
703 if(!$exception) { return $want_array ? @result : $result[0] }
705 if($tried++ || $self->connected) {
706 eval { $self->txn_rollback };
707 my $rollback_exception = $@;
708 if($rollback_exception) {
709 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
710 $self->throw_exception($exception) # propagate nested rollback
711 if $rollback_exception =~ /$exception_class/;
713 $self->throw_exception(
714 "Transaction aborted: ${exception}. "
715 . "Rollback failed: ${rollback_exception}"
718 $self->throw_exception($exception)
721 # We were not connected, and was first try - reconnect and retry
723 carp "Retrying $coderef after catching disconnected exception: $exception"
724 if $ENV{DBIC_DBIRETRY_DEBUG};
725 $self->_populate_dbh;
731 Our C<disconnect> method also performs a rollback first if the
732 database is not in C<AutoCommit> mode.
742 push @actions, ( $self->on_disconnect_call || () );
743 push @actions, $self->_parse_connect_do ('on_disconnect_do');
745 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
747 $self->_dbh_rollback unless $self->_dbh_autocommit;
749 $self->_dbh->disconnect;
755 =head2 with_deferred_fk_checks
759 =item Arguments: C<$coderef>
761 =item Return Value: The return value of $coderef
765 Storage specific method to run the code ref with FK checks deferred or
766 in MySQL's case disabled entirely.
770 # Storage subclasses should override this
771 sub with_deferred_fk_checks {
772 my ($self, $sub) = @_;
780 =item Arguments: none
782 =item Return Value: 1|0
786 Verifies that the the current database handle is active and ready to execute
787 an SQL statement (i.e. the connection did not get stale, server is still
788 answering, etc.) This method is used internally by L</dbh>.
794 return 0 unless $self->_seems_connected;
797 local $self->_dbh->{RaiseError} = 1;
802 sub _seems_connected {
805 my $dbh = $self->_dbh
808 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
815 return 0 if !$self->_dbh;
818 return $dbh->FETCH('Active');
824 my $dbh = $self->_dbh or return 0;
829 # handle pid changes correctly
830 # NOTE: assumes $self->_dbh is a valid $dbh
834 return if defined $self->_conn_pid && $self->_conn_pid == $$;
836 $self->_dbh->{InactiveDestroy} = 1;
843 sub ensure_connected {
846 unless ($self->connected) {
847 $self->_populate_dbh;
853 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
854 is guaranteed to be healthy by implicitly calling L</connected>, and if
855 necessary performing a reconnection before returning. Keep in mind that this
856 is very B<expensive> on some database engines. Consider using L<dbh_do>
864 if (not $self->_dbh) {
865 $self->_populate_dbh;
867 $self->ensure_connected;
872 # this is the internal "get dbh or connect (don't check)" method
875 $self->_verify_pid if $self->_dbh;
876 $self->_populate_dbh unless $self->_dbh;
880 sub _sql_maker_args {
885 array_datatypes => 1,
886 limit_dialect => $self->_get_dbh,
887 %{$self->_sql_maker_opts}
893 unless ($self->_sql_maker) {
894 my $sql_maker_class = $self->sql_maker_class;
895 $self->ensure_class_loaded ($sql_maker_class);
896 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
898 return $self->_sql_maker;
901 # nothing to do by default
908 my @info = @{$self->_dbi_connect_info || []};
909 $self->_dbh(undef); # in case ->connected failed we might get sent here
910 $self->_dbh($self->_connect(@info));
912 $self->_conn_pid($$);
913 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
915 $self->_determine_driver;
917 # Always set the transaction depth on connect, since
918 # there is no transaction in progress by definition
919 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
921 $self->_run_connection_actions unless $self->{_in_determine_driver};
924 sub _run_connection_actions {
928 push @actions, ( $self->on_connect_call || () );
929 push @actions, $self->_parse_connect_do ('on_connect_do');
931 $self->_do_connection_actions(connect_call_ => $_) for @actions;
934 sub _determine_driver {
937 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
938 my $started_connected = 0;
939 local $self->{_in_determine_driver} = 1;
941 if (ref($self) eq __PACKAGE__) {
943 if ($self->_dbh) { # we are connected
944 $driver = $self->_dbh->{Driver}{Name};
945 $started_connected = 1;
947 # if connect_info is a CODEREF, we have no choice but to connect
948 if (ref $self->_dbi_connect_info->[0] &&
949 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
950 $self->_populate_dbh;
951 $driver = $self->_dbh->{Driver}{Name};
954 # try to use dsn to not require being connected, the driver may still
955 # force a connection in _rebless to determine version
956 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
960 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
961 if ($self->load_optional_class($storage_class)) {
962 mro::set_mro($storage_class, 'c3');
963 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') {
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'} });
1175 if($self->{transaction_depth} == 0) {
1176 $self->debugobj->txn_begin()
1178 $self->_dbh_begin_work;
1180 elsif ($self->auto_savepoint) {
1183 $self->{transaction_depth}++;
1186 sub _dbh_begin_work {
1189 # if the user is utilizing txn_do - good for him, otherwise we need to
1190 # ensure that the $dbh is healthy on BEGIN.
1191 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1192 # will be replaced by a failure of begin_work itself (which will be
1193 # then retried on reconnect)
1194 if ($self->{_in_dbh_do}) {
1195 $self->_dbh->begin_work;
1197 $self->dbh_do(sub { $_[1]->begin_work });
1203 if ($self->{transaction_depth} == 1) {
1204 $self->debugobj->txn_commit()
1207 $self->{transaction_depth} = 0
1208 if $self->_dbh_autocommit;
1210 elsif($self->{transaction_depth} > 1) {
1211 $self->{transaction_depth}--;
1213 if $self->auto_savepoint;
1219 my $dbh = $self->_dbh
1220 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1226 my $dbh = $self->_dbh;
1228 if ($self->{transaction_depth} == 1) {
1229 $self->debugobj->txn_rollback()
1231 $self->{transaction_depth} = 0
1232 if $self->_dbh_autocommit;
1233 $self->_dbh_rollback;
1235 elsif($self->{transaction_depth} > 1) {
1236 $self->{transaction_depth}--;
1237 if ($self->auto_savepoint) {
1238 $self->svp_rollback;
1243 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1248 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1249 $error =~ /$exception_class/ and $self->throw_exception($error);
1250 # ensure that a failed rollback resets the transaction depth
1251 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1252 $self->throw_exception($error);
1258 my $dbh = $self->_dbh
1259 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1263 # This used to be the top-half of _execute. It was split out to make it
1264 # easier to override in NoBindVars without duping the rest. It takes up
1265 # all of _execute's args, and emits $sql, @bind.
1266 sub _prep_for_execute {
1267 my ($self, $op, $extra_bind, $ident, $args) = @_;
1269 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1270 $ident = $ident->from();
1273 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1276 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1278 return ($sql, \@bind);
1282 sub _fix_bind_params {
1283 my ($self, @bind) = @_;
1285 ### Turn @bind from something like this:
1286 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1288 ### ( "'1'", "'1'", "'3'" )
1291 if ( defined( $_ && $_->[1] ) ) {
1292 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1299 my ( $self, $sql, @bind ) = @_;
1301 if ( $self->debug ) {
1302 @bind = $self->_fix_bind_params(@bind);
1304 $self->debugobj->query_start( $sql, @bind );
1309 my ( $self, $sql, @bind ) = @_;
1311 if ( $self->debug ) {
1312 @bind = $self->_fix_bind_params(@bind);
1313 $self->debugobj->query_end( $sql, @bind );
1318 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1320 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1322 $self->_query_start( $sql, @$bind );
1324 my $sth = $self->sth($sql,$op);
1326 my $placeholder_index = 1;
1328 foreach my $bound (@$bind) {
1329 my $attributes = {};
1330 my($column_name, @data) = @$bound;
1332 if ($bind_attributes) {
1333 $attributes = $bind_attributes->{$column_name}
1334 if defined $bind_attributes->{$column_name};
1337 foreach my $data (@data) {
1338 my $ref = ref $data;
1339 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1341 $sth->bind_param($placeholder_index, $data, $attributes);
1342 $placeholder_index++;
1346 # Can this fail without throwing an exception anyways???
1347 my $rv = $sth->execute();
1348 $self->throw_exception($sth->errstr) if !$rv;
1350 $self->_query_end( $sql, @$bind );
1352 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1357 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1361 my ($self, $source, $to_insert) = @_;
1363 my $ident = $source->from;
1364 my $bind_attributes = $self->source_bind_attributes($source);
1366 my $updated_cols = {};
1368 foreach my $col ( $source->columns ) {
1369 if ( !defined $to_insert->{$col} ) {
1370 my $col_info = $source->column_info($col);
1372 if ( $col_info->{auto_nextval} ) {
1373 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1375 $col_info->{sequence} ||
1376 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1382 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1384 return $updated_cols;
1387 ## Currently it is assumed that all values passed will be "normal", i.e. not
1388 ## scalar refs, or at least, all the same type as the first set, the statement is
1389 ## only prepped once.
1391 my ($self, $source, $cols, $data) = @_;
1394 @colvalues{@$cols} = (0..$#$cols);
1396 for my $i (0..$#$cols) {
1397 my $first_val = $data->[0][$i];
1398 next unless ref $first_val eq 'SCALAR';
1400 $colvalues{ $cols->[$i] } = $first_val;
1403 # check for bad data and stringify stringifiable objects
1404 my $bad_slice = sub {
1405 my ($msg, $col_idx, $slice_idx) = @_;
1406 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1410 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1411 Data::Dumper::Concise::Dumper({
1412 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1418 for my $datum_idx (0..$#$data) {
1419 my $datum = $data->[$datum_idx];
1421 for my $col_idx (0..$#$cols) {
1422 my $val = $datum->[$col_idx];
1423 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1424 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1426 if ($is_literal_sql) {
1428 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1430 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1431 $bad_slice->("$reftype reference found where literal SQL expected",
1432 $col_idx, $datum_idx);
1434 elsif ($$val ne $$sqla_bind){
1435 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1436 $col_idx, $datum_idx);
1439 elsif (my $reftype = ref $val) {
1441 if (overload::Method($val, '""')) {
1442 $datum->[$col_idx] = "".$val;
1445 $bad_slice->("$reftype reference found where bind expected",
1446 $col_idx, $datum_idx);
1452 my ($sql, $bind) = $self->_prep_for_execute (
1453 'insert', undef, $source, [\%colvalues]
1457 my $empty_bind = 1 if (not @bind) &&
1458 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1460 if ((not @bind) && (not $empty_bind)) {
1461 $self->throw_exception(
1462 'Cannot insert_bulk without support for placeholders'
1466 $self->_query_start( $sql, ['__BULK__'] );
1467 my $sth = $self->sth($sql);
1471 # bind_param_array doesn't work if there are no binds
1472 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1475 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1476 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1480 $self->_query_end( $sql, ['__BULK__'] );
1482 return (wantarray ? ($rv, $sth, @bind) : $rv);
1485 sub _execute_array {
1486 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1488 my $guard = $self->txn_scope_guard unless $self->{transaction_depth} != 0;
1490 ## This must be an arrayref, else nothing works!
1491 my $tuple_status = [];
1493 ## Get the bind_attributes, if any exist
1494 my $bind_attributes = $self->source_bind_attributes($source);
1496 ## Bind the values and execute
1497 my $placeholder_index = 1;
1499 foreach my $bound (@$bind) {
1501 my $attributes = {};
1502 my ($column_name, $data_index) = @$bound;
1504 if( $bind_attributes ) {
1505 $attributes = $bind_attributes->{$column_name}
1506 if defined $bind_attributes->{$column_name};
1509 my @data = map { $_->[$data_index] } @$data;
1511 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1512 $placeholder_index++;
1516 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1518 my $err = $@ || $sth->errstr;
1520 # Statement must finish even if there was an exception.
1521 eval { $sth->finish };
1522 $err = $@ unless $err;
1526 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1528 $self->throw_exception("Unexpected populate error: $err")
1529 if ($i > $#$tuple_status);
1531 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1532 ($tuple_status->[$i][1] || $err),
1533 Data::Dumper::Concise::Dumper({
1534 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1539 $guard->commit if $guard;
1544 sub _dbh_execute_array {
1545 my ($self, $sth, $tuple_status, @extra) = @_;
1547 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1550 sub _dbh_execute_inserts_with_no_binds {
1551 my ($self, $sth, $count) = @_;
1553 my $guard = $self->txn_scope_guard unless $self->{transaction_depth} != 0;
1556 my $dbh = $self->_get_dbh;
1557 local $dbh->{RaiseError} = 1;
1558 local $dbh->{PrintError} = 0;
1560 $sth->execute foreach 1..$count;
1564 # Make sure statement is finished even if there was an exception.
1565 eval { $sth->finish };
1566 $exception = $@ unless $exception;
1568 $self->throw_exception($exception) if $exception;
1570 $guard->commit if $guard;
1576 my ($self, $source, @args) = @_;
1578 my $bind_attrs = $self->source_bind_attributes($source);
1580 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1585 my ($self, $source, @args) = @_;
1587 my $bind_attrs = $self->source_bind_attributes($source);
1589 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1592 # We were sent here because the $rs contains a complex search
1593 # which will require a subquery to select the correct rows
1594 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1596 # Generating a single PK column subquery is trivial and supported
1597 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1598 # Look at _multipk_update_delete()
1599 sub _subq_update_delete {
1601 my ($rs, $op, $values) = @_;
1603 my $rsrc = $rs->result_source;
1605 # quick check if we got a sane rs on our hands
1606 my @pcols = $rsrc->primary_columns;
1608 $self->throw_exception (
1610 "You must declare primary key(s) on source '%s' (via set_primary_key) in order to update or delete complex resultsets",
1611 $rsrc->source_name || $rsrc->from
1616 my $sel = $rs->_resolved_attrs->{select};
1617 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1620 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1622 join ("\x00", sort @$sel )
1624 $self->throw_exception (
1625 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1632 $op eq 'update' ? $values : (),
1633 { $pcols[0] => { -in => $rs->as_query } },
1638 return $self->_multipk_update_delete (@_);
1642 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1643 # resultset update/delete involving subqueries. So by default resort
1644 # to simple (and inefficient) delete_all style per-row opearations,
1645 # while allowing specific storages to override this with a faster
1648 sub _multipk_update_delete {
1649 return shift->_per_row_update_delete (@_);
1652 # This is the default loop used to delete/update rows for multi PK
1653 # resultsets, and used by mysql exclusively (because it can't do anything
1656 # We do not use $row->$op style queries, because resultset update/delete
1657 # is not expected to cascade (this is what delete_all/update_all is for).
1659 # There should be no race conditions as the entire operation is rolled
1662 sub _per_row_update_delete {
1664 my ($rs, $op, $values) = @_;
1666 my $rsrc = $rs->result_source;
1667 my @pcols = $rsrc->primary_columns;
1669 my $guard = $self->txn_scope_guard;
1671 # emulate the return value of $sth->execute for non-selects
1672 my $row_cnt = '0E0';
1674 my $subrs_cur = $rs->cursor;
1675 while (my @pks = $subrs_cur->next) {
1678 for my $i (0.. $#pcols) {
1679 $cond->{$pcols[$i]} = $pks[$i];
1684 $op eq 'update' ? $values : (),
1699 # localization is neccessary as
1700 # 1) there is no infrastructure to pass this around before SQLA2
1701 # 2) _select_args sets it and _prep_for_execute consumes it
1702 my $sql_maker = $self->sql_maker;
1703 local $sql_maker->{_dbic_rs_attrs};
1705 return $self->_execute($self->_select_args(@_));
1708 sub _select_args_to_query {
1711 # localization is neccessary as
1712 # 1) there is no infrastructure to pass this around before SQLA2
1713 # 2) _select_args sets it and _prep_for_execute consumes it
1714 my $sql_maker = $self->sql_maker;
1715 local $sql_maker->{_dbic_rs_attrs};
1717 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1718 # = $self->_select_args($ident, $select, $cond, $attrs);
1719 my ($op, $bind, $ident, $bind_attrs, @args) =
1720 $self->_select_args(@_);
1722 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1723 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1724 $prepared_bind ||= [];
1727 ? ($sql, $prepared_bind, $bind_attrs)
1728 : \[ "($sql)", @$prepared_bind ]
1733 my ($self, $ident, $select, $where, $attrs) = @_;
1735 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1737 my $sql_maker = $self->sql_maker;
1738 $sql_maker->{_dbic_rs_attrs} = {
1744 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1749 # calculate bind_attrs before possible $ident mangling
1750 my $bind_attrs = {};
1751 for my $alias (keys %$alias2source) {
1752 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1753 for my $col (keys %$bindtypes) {
1755 my $fqcn = join ('.', $alias, $col);
1756 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1758 # Unqialified column names are nice, but at the same time can be
1759 # rather ambiguous. What we do here is basically go along with
1760 # the loop, adding an unqualified column slot to $bind_attrs,
1761 # alongside the fully qualified name. As soon as we encounter
1762 # another column by that name (which would imply another table)
1763 # we unset the unqualified slot and never add any info to it
1764 # to avoid erroneous type binding. If this happens the users
1765 # only choice will be to fully qualify his column name
1767 if (exists $bind_attrs->{$col}) {
1768 $bind_attrs->{$col} = {};
1771 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1778 $attrs->{software_limit}
1780 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1782 $attrs->{software_limit} = 1;
1785 $self->throw_exception("rows attribute must be positive if present")
1786 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1788 # MySQL actually recommends this approach. I cringe.
1789 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1794 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1795 # storage, unless software limit was requested
1798 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1800 # limited prefetch with RNO subqueries
1804 $sql_maker->limit_dialect eq 'RowNumberOver'
1806 $attrs->{_prefetch_select}
1808 @{$attrs->{_prefetch_select}}
1812 ( $attrs->{group_by}
1814 @{$attrs->{group_by}}
1816 $attrs->{_prefetch_select}
1818 @{$attrs->{_prefetch_select}}
1821 ($ident, $select, $where, $attrs)
1822 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1826 ($attrs->{rows} || $attrs->{offset})
1828 $sql_maker->limit_dialect eq 'RowNumberOver'
1830 (ref $ident eq 'ARRAY' && @$ident > 1) # indicates a join
1832 scalar $sql_maker->_order_by_chunks ($attrs->{order_by})
1834 # the RNO limit dialect above mangles the SQL such that the join gets lost
1835 # wrap a subquery here
1837 push @limit, delete @{$attrs}{qw/rows offset/};
1839 my $subq = $self->_select_args_to_query (
1847 -alias => $attrs->{alias},
1848 -source_handle => $ident->[0]{-source_handle},
1849 $attrs->{alias} => $subq,
1852 # all part of the subquery now
1853 delete @{$attrs}{qw/order_by group_by having/};
1857 elsif (! $attrs->{software_limit} ) {
1858 push @limit, $attrs->{rows}, $attrs->{offset};
1862 # This would be the point to deflate anything found in $where
1863 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1864 # expect a row object. And all we have is a resultsource (it is trivial
1865 # to extract deflator coderefs via $alias2source above).
1867 # I don't see a way forward other than changing the way deflators are
1868 # invoked, and that's just bad...
1872 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1873 (qw/order_by group_by having/ )
1876 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1879 # Returns a counting SELECT for a simple count
1880 # query. Abstracted so that a storage could override
1881 # this to { count => 'firstcol' } or whatever makes
1882 # sense as a performance optimization
1884 #my ($self, $source, $rs_attrs) = @_;
1885 return { count => '*' };
1888 # Returns a SELECT which will end up in the subselect
1889 # There may or may not be a group_by, as the subquery
1890 # might have been called to accomodate a limit
1892 # Most databases would be happy with whatever ends up
1893 # here, but some choke in various ways.
1895 sub _subq_count_select {
1896 my ($self, $source, $rs_attrs) = @_;
1897 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1899 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1900 return @pcols ? \@pcols : [ 1 ];
1903 sub source_bind_attributes {
1904 my ($self, $source) = @_;
1906 my $bind_attributes;
1907 foreach my $column ($source->columns) {
1909 my $data_type = $source->column_info($column)->{data_type} || '';
1910 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1914 return $bind_attributes;
1921 =item Arguments: $ident, $select, $condition, $attrs
1925 Handle a SQL select statement.
1931 my ($ident, $select, $condition, $attrs) = @_;
1932 return $self->cursor_class->new($self, \@_, $attrs);
1937 my ($rv, $sth, @bind) = $self->_select(@_);
1938 my @row = $sth->fetchrow_array;
1939 my @nextrow = $sth->fetchrow_array if @row;
1940 if(@row && @nextrow) {
1941 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1943 # Need to call finish() to work round broken DBDs
1952 =item Arguments: $sql
1956 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1961 my ($self, $dbh, $sql) = @_;
1963 # 3 is the if_active parameter which avoids active sth re-use
1964 my $sth = $self->disable_sth_caching
1965 ? $dbh->prepare($sql)
1966 : $dbh->prepare_cached($sql, {}, 3);
1968 # XXX You would think RaiseError would make this impossible,
1969 # but apparently that's not true :(
1970 $self->throw_exception($dbh->errstr) if !$sth;
1976 my ($self, $sql) = @_;
1977 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
1980 sub _dbh_columns_info_for {
1981 my ($self, $dbh, $table) = @_;
1983 if ($dbh->can('column_info')) {
1986 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1987 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1989 while ( my $info = $sth->fetchrow_hashref() ){
1991 $column_info{data_type} = $info->{TYPE_NAME};
1992 $column_info{size} = $info->{COLUMN_SIZE};
1993 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1994 $column_info{default_value} = $info->{COLUMN_DEF};
1995 my $col_name = $info->{COLUMN_NAME};
1996 $col_name =~ s/^\"(.*)\"$/$1/;
1998 $result{$col_name} = \%column_info;
2001 return \%result if !$@ && scalar keys %result;
2005 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2007 my @columns = @{$sth->{NAME_lc}};
2008 for my $i ( 0 .. $#columns ){
2010 $column_info{data_type} = $sth->{TYPE}->[$i];
2011 $column_info{size} = $sth->{PRECISION}->[$i];
2012 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2014 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2015 $column_info{data_type} = $1;
2016 $column_info{size} = $2;
2019 $result{$columns[$i]} = \%column_info;
2023 foreach my $col (keys %result) {
2024 my $colinfo = $result{$col};
2025 my $type_num = $colinfo->{data_type};
2027 if(defined $type_num && $dbh->can('type_info')) {
2028 my $type_info = $dbh->type_info($type_num);
2029 $type_name = $type_info->{TYPE_NAME} if $type_info;
2030 $colinfo->{data_type} = $type_name if $type_name;
2037 sub columns_info_for {
2038 my ($self, $table) = @_;
2039 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2042 =head2 last_insert_id
2044 Return the row id of the last insert.
2048 sub _dbh_last_insert_id {
2049 # All Storage's need to register their own _dbh_last_insert_id
2050 # the old SQLite-based method was highly inappropriate
2053 my $class = ref $self;
2054 $self->throw_exception (<<EOE);
2056 No _dbh_last_insert_id() method found in $class.
2057 Since the method of obtaining the autoincrement id of the last insert
2058 operation varies greatly between different databases, this method must be
2059 individually implemented for every storage class.
2063 sub last_insert_id {
2065 $self->_dbh_last_insert_id ($self->_dbh, @_);
2068 =head2 _native_data_type
2072 =item Arguments: $type_name
2076 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2077 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2078 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2080 The default implementation returns C<undef>, implement in your Storage driver if
2081 you need this functionality.
2083 Should map types from other databases to the native RDBMS type, for example
2084 C<VARCHAR2> to C<VARCHAR>.
2086 Types with modifiers should map to the underlying data type. For example,
2087 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2089 Composite types should map to the container type, for example
2090 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2094 sub _native_data_type {
2095 #my ($self, $data_type) = @_;
2099 # Check if placeholders are supported at all
2100 sub _placeholders_supported {
2102 my $dbh = $self->_get_dbh;
2104 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2105 # but it is inaccurate more often than not
2107 local $dbh->{PrintError} = 0;
2108 local $dbh->{RaiseError} = 1;
2109 $dbh->do('select ?', {}, 1);
2114 # Check if placeholders bound to non-string types throw exceptions
2116 sub _typeless_placeholders_supported {
2118 my $dbh = $self->_get_dbh;
2121 local $dbh->{PrintError} = 0;
2122 local $dbh->{RaiseError} = 1;
2123 # this specifically tests a bind that is NOT a string
2124 $dbh->do('select 1 where 1 = ?', {}, 1);
2131 Returns the database driver name.
2136 shift->_get_dbh->{Driver}->{Name};
2139 =head2 bind_attribute_by_data_type
2141 Given a datatype from column info, returns a database specific bind
2142 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2143 let the database planner just handle it.
2145 Generally only needed for special case column types, like bytea in postgres.
2149 sub bind_attribute_by_data_type {
2153 =head2 is_datatype_numeric
2155 Given a datatype from column_info, returns a boolean value indicating if
2156 the current RDBMS considers it a numeric value. This controls how
2157 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2158 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2159 be performed instead of the usual C<eq>.
2163 sub is_datatype_numeric {
2164 my ($self, $dt) = @_;
2166 return 0 unless $dt;
2168 return $dt =~ /^ (?:
2169 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2174 =head2 create_ddl_dir
2178 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2182 Creates a SQL file based on the Schema, for each of the specified
2183 database engines in C<\@databases> in the given directory.
2184 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2186 Given a previous version number, this will also create a file containing
2187 the ALTER TABLE statements to transform the previous schema into the
2188 current one. Note that these statements may contain C<DROP TABLE> or
2189 C<DROP COLUMN> statements that can potentially destroy data.
2191 The file names are created using the C<ddl_filename> method below, please
2192 override this method in your schema if you would like a different file
2193 name format. For the ALTER file, the same format is used, replacing
2194 $version in the name with "$preversion-$version".
2196 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2197 The most common value for this would be C<< { add_drop_table => 1 } >>
2198 to have the SQL produced include a C<DROP TABLE> statement for each table
2199 created. For quoting purposes supply C<quote_table_names> and
2200 C<quote_field_names>.
2202 If no arguments are passed, then the following default values are assumed:
2206 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2208 =item version - $schema->schema_version
2210 =item directory - './'
2212 =item preversion - <none>
2216 By default, C<\%sqlt_args> will have
2218 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2220 merged with the hash passed in. To disable any of those features, pass in a
2221 hashref like the following
2223 { ignore_constraint_names => 0, # ... other options }
2226 WARNING: You are strongly advised to check all SQL files created, before applying
2231 sub create_ddl_dir {
2232 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2234 if(!$dir || !-d $dir) {
2235 carp "No directory given, using ./\n";
2238 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2239 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2241 my $schema_version = $schema->schema_version || '1.x';
2242 $version ||= $schema_version;
2245 add_drop_table => 1,
2246 ignore_constraint_names => 1,
2247 ignore_index_names => 1,
2251 $self->throw_exception("Can't create a ddl file without SQL::Translator: " . $self->_sqlt_version_error)
2252 if !$self->_sqlt_version_ok;
2254 my $sqlt = SQL::Translator->new( $sqltargs );
2256 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2257 my $sqlt_schema = $sqlt->translate({ data => $schema })
2258 or $self->throw_exception ($sqlt->error);
2260 foreach my $db (@$databases) {
2262 $sqlt->{schema} = $sqlt_schema;
2263 $sqlt->producer($db);
2266 my $filename = $schema->ddl_filename($db, $version, $dir);
2267 if (-e $filename && ($version eq $schema_version )) {
2268 # if we are dumping the current version, overwrite the DDL
2269 carp "Overwriting existing DDL file - $filename";
2273 my $output = $sqlt->translate;
2275 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2278 if(!open($file, ">$filename")) {
2279 $self->throw_exception("Can't open $filename for writing ($!)");
2282 print $file $output;
2285 next unless ($preversion);
2287 require SQL::Translator::Diff;
2289 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2290 if(!-e $prefilename) {
2291 carp("No previous schema file found ($prefilename)");
2295 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2297 carp("Overwriting existing diff file - $difffile");
2303 my $t = SQL::Translator->new($sqltargs);
2308 or $self->throw_exception ($t->error);
2310 my $out = $t->translate( $prefilename )
2311 or $self->throw_exception ($t->error);
2313 $source_schema = $t->schema;
2315 $source_schema->name( $prefilename )
2316 unless ( $source_schema->name );
2319 # The "new" style of producers have sane normalization and can support
2320 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2321 # And we have to diff parsed SQL against parsed SQL.
2322 my $dest_schema = $sqlt_schema;
2324 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2325 my $t = SQL::Translator->new($sqltargs);
2330 or $self->throw_exception ($t->error);
2332 my $out = $t->translate( $filename )
2333 or $self->throw_exception ($t->error);
2335 $dest_schema = $t->schema;
2337 $dest_schema->name( $filename )
2338 unless $dest_schema->name;
2341 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2345 if(!open $file, ">$difffile") {
2346 $self->throw_exception("Can't write to $difffile ($!)");
2354 =head2 deployment_statements
2358 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2362 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2364 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2365 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2367 C<$directory> is used to return statements from files in a previously created
2368 L</create_ddl_dir> directory and is optional. The filenames are constructed
2369 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2371 If no C<$directory> is specified then the statements are constructed on the
2372 fly using L<SQL::Translator> and C<$version> is ignored.
2374 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2378 sub deployment_statements {
2379 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2380 $type ||= $self->sqlt_type;
2381 $version ||= $schema->schema_version || '1.x';
2383 my $filename = $schema->ddl_filename($type, $version, $dir);
2387 open($file, "<$filename")
2388 or $self->throw_exception("Can't open $filename ($!)");
2391 return join('', @rows);
2394 $self->throw_exception("Can't deploy without either SQL::Translator or a ddl_dir: " . $self->_sqlt_version_error )
2395 if !$self->_sqlt_version_ok;
2397 # sources needs to be a parser arg, but for simplicty allow at top level
2399 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2400 if exists $sqltargs->{sources};
2402 my $tr = SQL::Translator->new(
2403 producer => "SQL::Translator::Producer::${type}",
2405 parser => 'SQL::Translator::Parser::DBIx::Class',
2412 @ret = $tr->translate;
2415 $ret[0] = $tr->translate;
2418 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2419 unless (@ret && defined $ret[0]);
2421 return $wa ? @ret : $ret[0];
2425 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2428 return if($line =~ /^--/);
2430 # next if($line =~ /^DROP/m);
2431 return if($line =~ /^BEGIN TRANSACTION/m);
2432 return if($line =~ /^COMMIT/m);
2433 return if $line =~ /^\s+$/; # skip whitespace only
2434 $self->_query_start($line);
2436 # do a dbh_do cycle here, as we need some error checking in
2437 # place (even though we will ignore errors)
2438 $self->dbh_do (sub { $_[1]->do($line) });
2441 carp qq{$@ (running "${line}")};
2443 $self->_query_end($line);
2445 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2446 if (@statements > 1) {
2447 foreach my $statement (@statements) {
2448 $deploy->( $statement );
2451 elsif (@statements == 1) {
2452 foreach my $line ( split(";\n", $statements[0])) {
2458 =head2 datetime_parser
2460 Returns the datetime parser class
2464 sub datetime_parser {
2466 return $self->{datetime_parser} ||= do {
2467 $self->build_datetime_parser(@_);
2471 =head2 datetime_parser_type
2473 Defines (returns) the datetime parser class - currently hardwired to
2474 L<DateTime::Format::MySQL>
2478 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2480 =head2 build_datetime_parser
2482 See L</datetime_parser>
2486 sub build_datetime_parser {
2488 my $type = $self->datetime_parser_type(@_);
2489 $self->ensure_class_loaded ($type);
2494 =head2 is_replicating
2496 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2497 replicate from a master database. Default is undef, which is the result
2498 returned by databases that don't support replication.
2502 sub is_replicating {
2507 =head2 lag_behind_master
2509 Returns a number that represents a certain amount of lag behind a master db
2510 when a given storage is replicating. The number is database dependent, but
2511 starts at zero and increases with the amount of lag. Default in undef
2515 sub lag_behind_master {
2519 # SQLT version handling
2521 my $_sqlt_version_ok; # private
2522 my $_sqlt_version_error; # private
2524 sub _sqlt_version_ok {
2525 if (!defined $_sqlt_version_ok) {
2526 eval "use SQL::Translator $minimum_sqlt_version";
2528 $_sqlt_version_ok = 0;
2529 $_sqlt_version_error = $@;
2532 $_sqlt_version_ok = 1;
2535 return $_sqlt_version_ok;
2538 sub _sqlt_version_error {
2539 shift->_sqlt_version_ok unless defined $_sqlt_version_ok;
2540 return $_sqlt_version_error;
2543 sub _sqlt_minimum_version { $minimum_sqlt_version };
2546 =head2 relname_to_table_alias
2550 =item Arguments: $relname, $join_count
2554 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2557 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2558 way these aliases are named.
2560 The default behavior is C<"$relname_$join_count" if $join_count > 1>, otherwise
2565 sub relname_to_table_alias {
2566 my ($self, $relname, $join_count) = @_;
2568 my $alias = ($join_count && $join_count > 1 ?
2569 join('_', $relname, $join_count) : $relname);
2577 $self->_verify_pid if $self->_dbh;
2579 # some databases need this to stop spewing warnings
2580 if (my $dbh = $self->_dbh) {
2582 eval { $dbh->disconnect };
2592 =head2 DBIx::Class and AutoCommit
2594 DBIx::Class can do some wonderful magic with handling exceptions,
2595 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2596 (the default) combined with C<txn_do> for transaction support.
2598 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2599 in an assumed transaction between commits, and you're telling us you'd
2600 like to manage that manually. A lot of the magic protections offered by
2601 this module will go away. We can't protect you from exceptions due to database
2602 disconnects because we don't know anything about how to restart your
2603 transactions. You're on your own for handling all sorts of exceptional
2604 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2610 Matt S. Trout <mst@shadowcatsystems.co.uk>
2612 Andy Grundman <andy@hybridized.org>
2616 You may distribute this code under the same terms as Perl itself.