1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
7 use base 'DBIx::Class::Storage';
10 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use DBIx::Class::Storage::Statistics;
17 __PACKAGE__->mk_group_accessors('simple' =>
18 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
19 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints/
22 # the values for these accessors are picked out (and deleted) from
23 # the attribute hashref passed to connect_info
24 my @storage_options = qw/
25 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
26 disable_sth_caching unsafe auto_savepoint
28 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
31 # default cursor class, overridable in connect_info attributes
32 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
34 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
35 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
40 DBIx::Class::Storage::DBI - DBI storage handler
44 my $schema = MySchema->connect('dbi:SQLite:my.db');
46 $schema->storage->debug(1);
47 $schema->dbh_do("DROP TABLE authors");
49 $schema->resultset('Book')->search({
50 written_on => $schema->storage->datetime_parser(DateTime->now)
55 This class represents the connection to an RDBMS via L<DBI>. See
56 L<DBIx::Class::Storage> for general information. This pod only
57 documents DBI-specific methods and behaviors.
64 my $new = shift->next::method(@_);
66 $new->transaction_depth(0);
67 $new->_sql_maker_opts({});
68 $new->{savepoints} = [];
69 $new->{_in_dbh_do} = 0;
77 This method is normally called by L<DBIx::Class::Schema/connection>, which
78 encapsulates its argument list in an arrayref before passing them here.
80 The argument list may contain:
86 The same 4-element argument set one would normally pass to
87 L<DBI/connect>, optionally followed by
88 L<extra attributes|/DBIx::Class specific connection attributes>
89 recognized by DBIx::Class:
91 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
95 A single code reference which returns a connected
96 L<DBI database handle|DBI/connect> optionally followed by
97 L<extra attributes|/DBIx::Class specific connection attributes> recognized
100 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
104 A single hashref with all the attributes and the dsn/user/password
107 $connect_info_args = [{
115 This is particularly useful for L<Catalyst> based applications, allowing the
116 following config (L<Config::General> style):
121 dsn dbi:mysql:database=test
130 Please note that the L<DBI> docs recommend that you always explicitly
131 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
132 recommends that it be set to I<1>, and that you perform transactions
133 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
134 to I<1> if you do not do explicitly set it to zero. This is the default
135 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
137 =head3 DBIx::Class specific connection attributes
139 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
140 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
141 the following connection options. These options can be mixed in with your other
142 L<DBI> connection attributes, or placed in a seperate hashref
143 (C<\%extra_attributes>) as shown above.
145 Every time C<connect_info> is invoked, any previous settings for
146 these options will be cleared before setting the new ones, regardless of
147 whether any options are specified in the new C<connect_info>.
154 Specifies things to do immediately after connecting or re-connecting to
155 the database. Its value may contain:
161 This contains one SQL statement to execute.
163 =item an array reference
165 This contains SQL statements to execute in order. Each element contains
166 a string or a code reference that returns a string.
168 =item a code reference
170 This contains some code to execute. Unlike code references within an
171 array reference, its return value is ignored.
175 =item on_disconnect_do
177 Takes arguments in the same form as L</on_connect_do> and executes them
178 immediately before disconnecting from the database.
180 Note, this only runs if you explicitly call L</disconnect> on the
183 =item on_connect_call
185 A more generalized form of L</on_connect_do> that calls the specified
186 C<connect_call_METHOD> methods in your storage driver.
188 on_connect_do => 'select 1'
192 on_connect_call => [ [ do_sql => 'select 1' ] ]
194 Its values may contain:
200 Will call the C<connect_call_METHOD> method.
202 =item a code reference
204 Will execute C<< $code->($storage) >>
206 =item an array reference
208 Each value can be a method name or code reference.
210 =item an array of arrays
212 For each array, the first item is taken to be the C<connect_call_> method name
213 or code reference, and the rest are parameters to it.
217 Some predefined storage methods you may use:
223 Executes a SQL string or a code reference that returns a SQL string. This is
224 what L</on_connect_do> and L</on_disconnect_do> use.
232 Will execute the scalar as SQL.
236 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
237 attributes hashref and bind values.
239 =item a code reference
241 Will execute C<< $code->($storage) >> and execute the return array refs as
248 Execute any statements necessary to initialize the database session to return
249 and accept datetime/timestamp values used with
250 L<DBIx::Class::InflateColumn::DateTime>.
252 Only necessary for some databases, see your specific storage driver for
253 implementation details.
257 =item on_disconnect_call
259 Takes arguments in the same form as L</on_connect_call> and executes them
260 immediately before disconnecting from the database.
262 Calls the C<disconnect_call_METHOD> methods as opposed to the
263 C<connect_call_METHOD> methods called by L</on_connect_call>.
265 Note, this only runs if you explicitly call L</disconnect> on the
268 =item disable_sth_caching
270 If set to a true value, this option will disable the caching of
271 statement handles via L<DBI/prepare_cached>.
275 Sets the limit dialect. This is useful for JDBC-bridge among others
276 where the remote SQL-dialect cannot be determined by the name of the
277 driver alone. See also L<SQL::Abstract::Limit>.
281 Specifies what characters to use to quote table and column names. If
282 you use this you will want to specify L</name_sep> as well.
284 C<quote_char> expects either a single character, in which case is it
285 is placed on either side of the table/column name, or an arrayref of length
286 2 in which case the table/column name is placed between the elements.
288 For example under MySQL you should use C<< quote_char => '`' >>, and for
289 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
293 This only needs to be used in conjunction with C<quote_char>, and is used to
294 specify the charecter that seperates elements (schemas, tables, columns) from
295 each other. In most cases this is simply a C<.>.
297 The consequences of not supplying this value is that L<SQL::Abstract>
298 will assume DBIx::Class' uses of aliases to be complete column
299 names. The output will look like I<"me.name"> when it should actually
304 This Storage driver normally installs its own C<HandleError>, sets
305 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
306 all database handles, including those supplied by a coderef. It does this
307 so that it can have consistent and useful error behavior.
309 If you set this option to a true value, Storage will not do its usual
310 modifications to the database handle's attributes, and instead relies on
311 the settings in your connect_info DBI options (or the values you set in
312 your connection coderef, in the case that you are connecting via coderef).
314 Note that your custom settings can cause Storage to malfunction,
315 especially if you set a C<HandleError> handler that suppresses exceptions
316 and/or disable C<RaiseError>.
320 If this option is true, L<DBIx::Class> will use savepoints when nesting
321 transactions, making it possible to recover from failure in the inner
322 transaction without having to abort all outer transactions.
326 Use this argument to supply a cursor class other than the default
327 L<DBIx::Class::Storage::DBI::Cursor>.
331 Some real-life examples of arguments to L</connect_info> and
332 L<DBIx::Class::Schema/connect>
334 # Simple SQLite connection
335 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
338 ->connect_info([ sub { DBI->connect(...) } ]);
340 # A bit more complicated
347 { quote_char => q{"}, name_sep => q{.} },
351 # Equivalent to the previous example
357 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
361 # Same, but with hashref as argument
362 # See parse_connect_info for explanation
365 dsn => 'dbi:Pg:dbname=foo',
367 password => 'my_pg_password',
374 # Subref + DBIx::Class-specific connection options
377 sub { DBI->connect(...) },
381 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
382 disable_sth_caching => 1,
392 my ($self, $info_arg) = @_;
394 return $self->_connect_info if !$info_arg;
396 my @args = @$info_arg; # take a shallow copy for further mutilation
397 $self->_connect_info([@args]); # copy for _connect_info
400 # combine/pre-parse arguments depending on invocation style
403 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
404 %attrs = %{ $args[1] || {} };
407 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
408 %attrs = %{$args[0]};
410 for (qw/password user dsn/) {
411 unshift @args, delete $attrs{$_};
414 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
416 % { $args[3] || {} },
417 % { $args[4] || {} },
419 @args = @args[0,1,2];
422 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
423 # the new set of options
424 $self->_sql_maker(undef);
425 $self->_sql_maker_opts({});
428 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
429 if(my $value = delete $attrs{$storage_opt}) {
430 $self->$storage_opt($value);
433 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
434 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
435 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
440 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
442 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
443 $self->_connect_info;
448 This method is deprecated in favour of setting via L</connect_info>.
452 =head2 on_disconnect_do
454 This method is deprecated in favour of setting via L</connect_info>.
458 sub _parse_connect_do {
459 my ($self, $type) = @_;
461 my $val = $self->$type;
462 return () if not defined $val;
467 push @res, [ 'do_sql', $val ];
468 } elsif (ref($val) eq 'CODE') {
470 } elsif (ref($val) eq 'ARRAY') {
471 push @res, map { [ 'do_sql', $_ ] } @$val;
473 $self->throw_exception("Invalid type for $type: ".ref($val));
481 Arguments: ($subref | $method_name), @extra_coderef_args?
483 Execute the given $subref or $method_name using the new exception-based
484 connection management.
486 The first two arguments will be the storage object that C<dbh_do> was called
487 on and a database handle to use. Any additional arguments will be passed
488 verbatim to the called subref as arguments 2 and onwards.
490 Using this (instead of $self->_dbh or $self->dbh) ensures correct
491 exception handling and reconnection (or failover in future subclasses).
493 Your subref should have no side-effects outside of the database, as
494 there is the potential for your subref to be partially double-executed
495 if the database connection was stale/dysfunctional.
499 my @stuff = $schema->storage->dbh_do(
501 my ($storage, $dbh, @cols) = @_;
502 my $cols = join(q{, }, @cols);
503 $dbh->selectrow_array("SELECT $cols FROM foo");
514 my $dbh = $self->_dbh;
516 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
517 || $self->{transaction_depth};
519 local $self->{_in_dbh_do} = 1;
522 my $want_array = wantarray;
525 $self->_verify_pid if $dbh;
527 $self->_populate_dbh;
532 @result = $self->$code($dbh, @_);
534 elsif(defined $want_array) {
535 $result[0] = $self->$code($dbh, @_);
538 $self->$code($dbh, @_);
543 if(!$exception) { return $want_array ? @result : $result[0] }
545 $self->throw_exception($exception) if $self->connected;
547 # We were not connected - reconnect and retry, but let any
548 # exception fall right through this time
549 $self->_populate_dbh;
550 $self->$code($self->_dbh, @_);
553 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
554 # It also informs dbh_do to bypass itself while under the direction of txn_do,
555 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
560 ref $coderef eq 'CODE' or $self->throw_exception
561 ('$coderef must be a CODE reference');
563 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
565 local $self->{_in_dbh_do} = 1;
568 my $want_array = wantarray;
573 $self->_verify_pid if $self->_dbh;
574 $self->_populate_dbh if !$self->_dbh;
578 @result = $coderef->(@_);
580 elsif(defined $want_array) {
581 $result[0] = $coderef->(@_);
590 if(!$exception) { return $want_array ? @result : $result[0] }
592 if($tried++ > 0 || $self->connected) {
593 eval { $self->txn_rollback };
594 my $rollback_exception = $@;
595 if($rollback_exception) {
596 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
597 $self->throw_exception($exception) # propagate nested rollback
598 if $rollback_exception =~ /$exception_class/;
600 $self->throw_exception(
601 "Transaction aborted: ${exception}. "
602 . "Rollback failed: ${rollback_exception}"
605 $self->throw_exception($exception)
608 # We were not connected, and was first try - reconnect and retry
610 $self->_populate_dbh;
616 Our C<disconnect> method also performs a rollback first if the
617 database is not in C<AutoCommit> mode.
624 if( $self->connected ) {
627 push @actions, ( $self->on_disconnect_call || () );
628 push @actions, $self->_parse_connect_do ('on_disconnect_do');
630 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
632 $self->_dbh_rollback unless $self->_dbh_autocommit;
634 $self->_dbh->disconnect;
640 =head2 with_deferred_fk_checks
644 =item Arguments: C<$coderef>
646 =item Return Value: The return value of $coderef
650 Storage specific method to run the code ref with FK checks deferred or
651 in MySQL's case disabled entirely.
655 # Storage subclasses should override this
656 sub with_deferred_fk_checks {
657 my ($self, $sub) = @_;
665 if(my $dbh = $self->_dbh) {
666 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
673 return 0 if !$self->_dbh;
675 return ($dbh->FETCH('Active') && $self->_ping);
684 my $dbh = $self->_dbh or return 0;
689 # handle pid changes correctly
690 # NOTE: assumes $self->_dbh is a valid $dbh
694 return if defined $self->_conn_pid && $self->_conn_pid == $$;
696 $self->_dbh->{InactiveDestroy} = 1;
703 sub ensure_connected {
706 unless ($self->connected) {
707 $self->_populate_dbh;
713 Returns the dbh - a data base handle of class L<DBI>.
720 $self->ensure_connected;
724 sub _sql_maker_args {
727 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
732 unless ($self->_sql_maker) {
733 my $sql_maker_class = $self->sql_maker_class;
734 $self->ensure_class_loaded ($sql_maker_class);
735 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
737 return $self->_sql_maker;
744 my @info = @{$self->_dbi_connect_info || []};
745 $self->_dbh($self->_connect(@info));
747 $self->_conn_pid($$);
748 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
750 $self->_determine_driver;
752 # Always set the transaction depth on connect, since
753 # there is no transaction in progress by definition
754 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
758 push @actions, ( $self->on_connect_call || () );
759 push @actions, $self->_parse_connect_do ('on_connect_do');
761 $self->_do_connection_actions(connect_call_ => $_) for @actions;
764 sub _determine_driver {
767 if (not $self->_driver_determined) {
768 if (ref($self) eq __PACKAGE__) {
771 if ($self->_dbh) { # we are connected
772 $driver = $self->_dbh->{Driver}{Name};
774 # try to use dsn to not require being connected, the driver may still
775 # force a connection in _rebless to determine version
776 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
779 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
780 if ($self->load_optional_class($storage_class)) {
781 mro::set_mro($storage_class, 'c3');
782 bless $self, $storage_class;
787 $self->_driver_determined(1);
791 sub _do_connection_actions {
793 my $method_prefix = shift;
796 if (not ref($call)) {
797 my $method = $method_prefix . $call;
799 } elsif (ref($call) eq 'CODE') {
801 } elsif (ref($call) eq 'ARRAY') {
802 if (ref($call->[0]) ne 'ARRAY') {
803 $self->_do_connection_actions($method_prefix, $_) for @$call;
805 $self->_do_connection_actions($method_prefix, @$_) for @$call;
808 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
814 sub connect_call_do_sql {
816 $self->_do_query(@_);
819 sub disconnect_call_do_sql {
821 $self->_do_query(@_);
824 # override in db-specific backend when necessary
825 sub connect_call_datetime_setup { 1 }
828 my ($self, $action) = @_;
830 if (ref $action eq 'CODE') {
831 $action = $action->($self);
832 $self->_do_query($_) foreach @$action;
835 # Most debuggers expect ($sql, @bind), so we need to exclude
836 # the attribute hash which is the second argument to $dbh->do
837 # furthermore the bind values are usually to be presented
838 # as named arrayref pairs, so wrap those here too
839 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
840 my $sql = shift @do_args;
841 my $attrs = shift @do_args;
842 my @bind = map { [ undef, $_ ] } @do_args;
844 $self->_query_start($sql, @bind);
845 $self->_dbh->do($sql, $attrs, @do_args);
846 $self->_query_end($sql, @bind);
853 my ($self, @info) = @_;
855 $self->throw_exception("You failed to provide any connection info")
858 my ($old_connect_via, $dbh);
860 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
861 $old_connect_via = $DBI::connect_via;
862 $DBI::connect_via = 'connect';
866 if(ref $info[0] eq 'CODE') {
870 $dbh = DBI->connect(@info);
873 if($dbh && !$self->unsafe) {
874 my $weak_self = $self;
875 Scalar::Util::weaken($weak_self);
876 $dbh->{HandleError} = sub {
878 $weak_self->throw_exception("DBI Exception: $_[0]");
881 croak ("DBI Exception: $_[0]");
884 $dbh->{ShowErrorStatement} = 1;
885 $dbh->{RaiseError} = 1;
886 $dbh->{PrintError} = 0;
890 $DBI::connect_via = $old_connect_via if $old_connect_via;
892 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
895 $self->_dbh_autocommit($dbh->{AutoCommit});
901 my ($self, $name) = @_;
903 $name = $self->_svp_generate_name
904 unless defined $name;
906 $self->throw_exception ("You can't use savepoints outside a transaction")
907 if $self->{transaction_depth} == 0;
909 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
910 unless $self->can('_svp_begin');
912 push @{ $self->{savepoints} }, $name;
914 $self->debugobj->svp_begin($name) if $self->debug;
916 return $self->_svp_begin($name);
920 my ($self, $name) = @_;
922 $self->throw_exception ("You can't use savepoints outside a transaction")
923 if $self->{transaction_depth} == 0;
925 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
926 unless $self->can('_svp_release');
929 $self->throw_exception ("Savepoint '$name' does not exist")
930 unless grep { $_ eq $name } @{ $self->{savepoints} };
932 # Dig through the stack until we find the one we are releasing. This keeps
933 # the stack up to date.
936 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
938 $name = pop @{ $self->{savepoints} };
941 $self->debugobj->svp_release($name) if $self->debug;
943 return $self->_svp_release($name);
947 my ($self, $name) = @_;
949 $self->throw_exception ("You can't use savepoints outside a transaction")
950 if $self->{transaction_depth} == 0;
952 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
953 unless $self->can('_svp_rollback');
956 # If they passed us a name, verify that it exists in the stack
957 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
958 $self->throw_exception("Savepoint '$name' does not exist!");
961 # Dig through the stack until we find the one we are releasing. This keeps
962 # the stack up to date.
963 while(my $s = pop(@{ $self->{savepoints} })) {
964 last if($s eq $name);
966 # Add the savepoint back to the stack, as a rollback doesn't remove the
967 # named savepoint, only everything after it.
968 push(@{ $self->{savepoints} }, $name);
970 # We'll assume they want to rollback to the last savepoint
971 $name = $self->{savepoints}->[-1];
974 $self->debugobj->svp_rollback($name) if $self->debug;
976 return $self->_svp_rollback($name);
979 sub _svp_generate_name {
982 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
987 $self->ensure_connected();
988 if($self->{transaction_depth} == 0) {
989 $self->debugobj->txn_begin()
991 # this isn't ->_dbh-> because
992 # we should reconnect on begin_work
993 # for AutoCommit users
994 $self->_dbh_begin_work;
995 } elsif ($self->auto_savepoint) {
998 $self->{transaction_depth}++;
1001 sub _dbh_begin_work {
1003 $self->dbh->begin_work;
1008 if ($self->{transaction_depth} == 1) {
1009 my $dbh = $self->_dbh;
1010 $self->debugobj->txn_commit()
1013 $self->{transaction_depth} = 0
1014 if $self->_dbh_autocommit;
1016 elsif($self->{transaction_depth} > 1) {
1017 $self->{transaction_depth}--;
1019 if $self->auto_savepoint;
1025 $self->_dbh->commit;
1030 my $dbh = $self->_dbh;
1032 if ($self->{transaction_depth} == 1) {
1033 $self->debugobj->txn_rollback()
1035 $self->{transaction_depth} = 0
1036 if $self->_dbh_autocommit;
1037 $self->_dbh_rollback;
1039 elsif($self->{transaction_depth} > 1) {
1040 $self->{transaction_depth}--;
1041 if ($self->auto_savepoint) {
1042 $self->svp_rollback;
1047 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1052 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1053 $error =~ /$exception_class/ and $self->throw_exception($error);
1054 # ensure that a failed rollback resets the transaction depth
1055 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1056 $self->throw_exception($error);
1062 $self->_dbh->rollback;
1065 # This used to be the top-half of _execute. It was split out to make it
1066 # easier to override in NoBindVars without duping the rest. It takes up
1067 # all of _execute's args, and emits $sql, @bind.
1068 sub _prep_for_execute {
1069 my ($self, $op, $extra_bind, $ident, $args) = @_;
1071 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1072 $ident = $ident->from();
1075 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1078 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1080 return ($sql, \@bind);
1084 sub _fix_bind_params {
1085 my ($self, @bind) = @_;
1087 ### Turn @bind from something like this:
1088 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1090 ### ( "'1'", "'1'", "'3'" )
1093 if ( defined( $_ && $_->[1] ) ) {
1094 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1101 my ( $self, $sql, @bind ) = @_;
1103 if ( $self->debug ) {
1104 @bind = $self->_fix_bind_params(@bind);
1106 $self->debugobj->query_start( $sql, @bind );
1111 my ( $self, $sql, @bind ) = @_;
1113 if ( $self->debug ) {
1114 @bind = $self->_fix_bind_params(@bind);
1115 $self->debugobj->query_end( $sql, @bind );
1120 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1122 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1124 $self->_query_start( $sql, @$bind );
1126 my $sth = $self->sth($sql,$op);
1128 my $placeholder_index = 1;
1130 foreach my $bound (@$bind) {
1131 my $attributes = {};
1132 my($column_name, @data) = @$bound;
1134 if ($bind_attributes) {
1135 $attributes = $bind_attributes->{$column_name}
1136 if defined $bind_attributes->{$column_name};
1139 foreach my $data (@data) {
1140 my $ref = ref $data;
1141 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1143 $sth->bind_param($placeholder_index, $data, $attributes);
1144 $placeholder_index++;
1148 # Can this fail without throwing an exception anyways???
1149 my $rv = $sth->execute();
1150 $self->throw_exception($sth->errstr) if !$rv;
1152 $self->_query_end( $sql, @$bind );
1154 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1159 $self->dbh_do('_dbh_execute', @_)
1163 my ($self, $source, $to_insert) = @_;
1165 # redispatch to insert method of storage we reblessed into, if necessary
1166 if (not $self->_driver_determined) {
1167 $self->_determine_driver;
1168 goto $self->can('insert');
1171 my $ident = $source->from;
1172 my $bind_attributes = $self->source_bind_attributes($source);
1174 my $updated_cols = {};
1176 foreach my $col ( $source->columns ) {
1177 if ( !defined $to_insert->{$col} ) {
1178 my $col_info = $source->column_info($col);
1180 if ( $col_info->{auto_nextval} ) {
1181 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1186 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1188 return $updated_cols;
1191 ## Still not quite perfect, and EXPERIMENTAL
1192 ## Currently it is assumed that all values passed will be "normal", i.e. not
1193 ## scalar refs, or at least, all the same type as the first set, the statement is
1194 ## only prepped once.
1196 my ($self, $source, $cols, $data) = @_;
1198 my $table = $source->from;
1199 @colvalues{@$cols} = (0..$#$cols);
1200 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1202 $self->_query_start( $sql, @bind );
1203 my $sth = $self->sth($sql);
1205 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1207 ## This must be an arrayref, else nothing works!
1208 my $tuple_status = [];
1210 ## Get the bind_attributes, if any exist
1211 my $bind_attributes = $self->source_bind_attributes($source);
1213 ## Bind the values and execute
1214 my $placeholder_index = 1;
1216 foreach my $bound (@bind) {
1218 my $attributes = {};
1219 my ($column_name, $data_index) = @$bound;
1221 if( $bind_attributes ) {
1222 $attributes = $bind_attributes->{$column_name}
1223 if defined $bind_attributes->{$column_name};
1226 my @data = map { $_->[$data_index] } @$data;
1228 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1229 $placeholder_index++;
1231 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1234 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1236 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1237 if ($i > $#$tuple_status);
1239 require Data::Dumper;
1240 local $Data::Dumper::Terse = 1;
1241 local $Data::Dumper::Indent = 1;
1242 local $Data::Dumper::Useqq = 1;
1243 local $Data::Dumper::Quotekeys = 0;
1245 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1246 $tuple_status->[$i][1],
1247 Data::Dumper::Dumper(
1248 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1252 $self->throw_exception($sth->errstr) if !$rv;
1254 $self->_query_end( $sql, @bind );
1255 return (wantarray ? ($rv, $sth, @bind) : $rv);
1259 my $self = shift @_;
1260 my $source = shift @_;
1261 my $bind_attributes = $self->source_bind_attributes($source);
1263 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1268 my $self = shift @_;
1269 my $source = shift @_;
1271 my $bind_attrs = $self->source_bind_attributes($source);
1273 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1276 # We were sent here because the $rs contains a complex search
1277 # which will require a subquery to select the correct rows
1278 # (i.e. joined or limited resultsets)
1280 # Genarating a single PK column subquery is trivial and supported
1281 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1282 # Look at _multipk_update_delete()
1283 sub _subq_update_delete {
1285 my ($rs, $op, $values) = @_;
1287 my $rsrc = $rs->result_source;
1289 # we already check this, but double check naively just in case. Should be removed soon
1290 my $sel = $rs->_resolved_attrs->{select};
1291 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1292 my @pcols = $rsrc->primary_columns;
1293 if (@$sel != @pcols) {
1294 $self->throw_exception (
1295 'Subquery update/delete can not be called on resultsets selecting a'
1296 .' number of columns different than the number of primary keys'
1303 $op eq 'update' ? $values : (),
1304 { $pcols[0] => { -in => $rs->as_query } },
1309 return $self->_multipk_update_delete (@_);
1313 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1314 # resultset update/delete involving subqueries. So by default resort
1315 # to simple (and inefficient) delete_all style per-row opearations,
1316 # while allowing specific storages to override this with a faster
1319 sub _multipk_update_delete {
1320 return shift->_per_row_update_delete (@_);
1323 # This is the default loop used to delete/update rows for multi PK
1324 # resultsets, and used by mysql exclusively (because it can't do anything
1327 # We do not use $row->$op style queries, because resultset update/delete
1328 # is not expected to cascade (this is what delete_all/update_all is for).
1330 # There should be no race conditions as the entire operation is rolled
1333 sub _per_row_update_delete {
1335 my ($rs, $op, $values) = @_;
1337 my $rsrc = $rs->result_source;
1338 my @pcols = $rsrc->primary_columns;
1340 my $guard = $self->txn_scope_guard;
1342 # emulate the return value of $sth->execute for non-selects
1343 my $row_cnt = '0E0';
1345 my $subrs_cur = $rs->cursor;
1346 while (my @pks = $subrs_cur->next) {
1349 for my $i (0.. $#pcols) {
1350 $cond->{$pcols[$i]} = $pks[$i];
1355 $op eq 'update' ? $values : (),
1370 # localization is neccessary as
1371 # 1) there is no infrastructure to pass this around before SQLA2
1372 # 2) _select_args sets it and _prep_for_execute consumes it
1373 my $sql_maker = $self->sql_maker;
1374 local $sql_maker->{_dbic_rs_attrs};
1376 return $self->_execute($self->_select_args(@_));
1379 sub _select_args_to_query {
1382 # localization is neccessary as
1383 # 1) there is no infrastructure to pass this around before SQLA2
1384 # 2) _select_args sets it and _prep_for_execute consumes it
1385 my $sql_maker = $self->sql_maker;
1386 local $sql_maker->{_dbic_rs_attrs};
1388 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1389 # = $self->_select_args($ident, $select, $cond, $attrs);
1390 my ($op, $bind, $ident, $bind_attrs, @args) =
1391 $self->_select_args(@_);
1393 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1394 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1395 $prepared_bind ||= [];
1398 ? ($sql, $prepared_bind, $bind_attrs)
1399 : \[ "($sql)", @$prepared_bind ]
1404 my ($self, $ident, $select, $where, $attrs) = @_;
1406 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1408 my $sql_maker = $self->sql_maker;
1409 $sql_maker->{_dbic_rs_attrs} = {
1415 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1420 # calculate bind_attrs before possible $ident mangling
1421 my $bind_attrs = {};
1422 for my $alias (keys %$alias2source) {
1423 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1424 for my $col (keys %$bindtypes) {
1426 my $fqcn = join ('.', $alias, $col);
1427 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1429 # Unqialified column names are nice, but at the same time can be
1430 # rather ambiguous. What we do here is basically go along with
1431 # the loop, adding an unqualified column slot to $bind_attrs,
1432 # alongside the fully qualified name. As soon as we encounter
1433 # another column by that name (which would imply another table)
1434 # we unset the unqualified slot and never add any info to it
1435 # to avoid erroneous type binding. If this happens the users
1436 # only choice will be to fully qualify his column name
1438 if (exists $bind_attrs->{$col}) {
1439 $bind_attrs->{$col} = {};
1442 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1449 $attrs->{software_limit}
1451 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1453 $attrs->{software_limit} = 1;
1456 $self->throw_exception("rows attribute must be positive if present")
1457 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1459 # MySQL actually recommends this approach. I cringe.
1460 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1465 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1466 # otherwise delegate the limiting to the storage, unless software limit was requested
1468 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1470 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1471 $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1473 ($ident, $select, $where, $attrs)
1474 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1476 elsif (! $attrs->{software_limit} ) {
1477 push @limit, $attrs->{rows}, $attrs->{offset};
1481 # This would be the point to deflate anything found in $where
1482 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1483 # expect a row object. And all we have is a resultsource (it is trivial
1484 # to extract deflator coderefs via $alias2source above).
1486 # I don't see a way forward other than changing the way deflators are
1487 # invoked, and that's just bad...
1491 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1492 (qw/order_by group_by having/ )
1495 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1499 # This is the code producing joined subqueries like:
1500 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1502 sub _adjust_select_args_for_complex_prefetch {
1503 my ($self, $from, $select, $where, $attrs) = @_;
1505 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1506 if (ref $from ne 'ARRAY');
1508 # copies for mangling
1510 $select = [ @$select ];
1511 $attrs = { %$attrs };
1513 # separate attributes
1514 my $sub_attrs = { %$attrs };
1515 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1516 delete $sub_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1518 my $select_root_alias = $attrs->{alias};
1519 my $sql_maker = $self->sql_maker;
1521 # create subquery select list - consider only stuff *not* brought in by the prefetch
1522 my $sub_select = [];
1524 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{_prefetch_select}} - 1) {
1525 my $sel = $attrs->{select}[$i];
1527 # alias any functions to the dbic-side 'as' label
1528 # adjust the outer select accordingly
1529 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1530 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1531 $select->[$i] = join ('.', $attrs->{alias}, ($attrs->{as}[$i] || "select_$i") );
1534 push @$sub_select, $sel;
1537 # bring over all non-collapse-induced order_by into the inner query (if any)
1538 # the outer one will have to keep them all
1539 delete $sub_attrs->{order_by};
1540 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1541 $sub_attrs->{order_by} = [
1542 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1546 # mangle {from}, keep in mind that $from is "headless" from here on
1547 my $join_root = shift @$from;
1550 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1552 # in complex search_related chains $select_root_alias may *not* be
1553 # 'me' so always include it in the inner join
1554 $inner_joins{$select_root_alias} = 1 if ($join_root->{-alias} ne $select_root_alias);
1557 # decide which parts of the join will remain on the inside
1559 # this is not a very viable optimisation, but it was written
1560 # before I realised this, so might as well remain. We can throw
1561 # away _any_ branches of the join tree that are:
1562 # 1) not mentioned in the condition/order
1563 # 2) left-join leaves (or left-join leaf chains)
1564 # Most of the join conditions will not satisfy this, but for real
1565 # complex queries some might, and we might make some RDBMS happy.
1568 # since we do not have introspectable SQLA, we fall back to ugly
1569 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1570 # in order to determine what goes into %inner_joins
1571 # It may not be very efficient, but it's a reasonable stop-gap
1573 # produce stuff unquoted, so it can be scanned
1574 local $sql_maker->{quote_char};
1575 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1579 { ref $_ ? $_->[0] : $_ }
1580 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1583 my $where_sql = $sql_maker->where ($where);
1584 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1587 for my $alias (keys %join_info) {
1589 # any table alias found on a column name in where or order_by
1590 # gets included in %inner_joins
1591 # Also any parent joins that are needed to reach this particular alias
1592 for my $piece ($select_sql, $where_sql, @order_by ) {
1593 if ($piece =~ /\b $alias $sep/x) {
1594 $inner_joins{$alias} = 1;
1600 # scan for non-leaf/non-left joins and mark as needed
1601 # also mark all ancestor joins that are needed to reach this particular alias
1602 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1604 # traverse by the size of the -join_path i.e. reverse depth first
1605 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1607 my $j = $join_info{$alias};
1608 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1610 if ($inner_joins{$alias}) {
1611 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1615 # construct the inner $from for the subquery
1616 my $inner_from = [ $join_root ];
1617 for my $j (@$from) {
1618 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1621 # if a multi-type join was needed in the subquery ("multi" is indicated by
1622 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1623 unless ($sub_attrs->{group_by}) {
1624 for my $alias (keys %inner_joins) {
1626 # the dot comes from some weirdness in collapse
1627 # remove after the rewrite
1628 if ($attrs->{collapse}{".$alias"}) {
1629 $sub_attrs->{group_by} ||= $sub_select;
1635 # generate the subquery
1636 my $subq = $self->_select_args_to_query (
1642 my $subq_joinspec = {
1643 -alias => $select_root_alias,
1644 -source_handle => $join_root->{-source_handle},
1645 $select_root_alias => $subq,
1648 # Generate a new from (really just replace the join slot with the subquery)
1649 # Before we would start the outer chain from the subquery itself (i.e.
1650 # SELECT ... FROM (SELECT ... ) alias JOIN ..., but this turned out to be
1651 # a bad idea for search_related, as the root of the chain was effectively
1652 # lost (i.e. $artist_rs->search_related ('cds'... ) would result in alias
1653 # of 'cds', which would prevent from doing things like order_by artist.*)
1654 # See t/prefetch/via_search_related.t for a better idea
1656 if ($join_root->{-alias} eq $select_root_alias) { # just swap the root part and we're done
1662 else { # this is trickier
1663 @outer_from = ($join_root);
1665 for my $j (@$from) {
1666 if ($j->[0]{-alias} eq $select_root_alias) {
1673 push @outer_from, $j;
1678 # This is totally horrific - the $where ends up in both the inner and outer query
1679 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1680 # then if where conditions apply to the *right* side of the prefetch, you may have
1681 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1682 # the outer select to exclude joins you didin't want in the first place
1684 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1685 return (\@outer_from, $select, $where, $attrs);
1688 sub _resolve_ident_sources {
1689 my ($self, $ident) = @_;
1691 my $alias2source = {};
1694 # the reason this is so contrived is that $ident may be a {from}
1695 # structure, specifying multiple tables to join
1696 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1697 # this is compat mode for insert/update/delete which do not deal with aliases
1698 $alias2source->{me} = $ident;
1701 elsif (ref $ident eq 'ARRAY') {
1705 if (ref $_ eq 'HASH') {
1707 $rs_alias = $tabinfo->{-alias};
1709 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1713 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1714 if ($tabinfo->{-source_handle});
1718 return ($alias2source, $rs_alias);
1721 # Takes $ident, \@column_names
1723 # returns { $column_name => \%column_info, ... }
1724 # also note: this adds -result_source => $rsrc to the column info
1727 # my $col_sources = $self->_resolve_column_info($ident, @column_names);
1728 sub _resolve_column_info {
1729 my ($self, $ident, $colnames) = @_;
1730 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1732 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1735 my (%return, %seen_cols);
1737 # compile a global list of column names, to be able to properly
1738 # disambiguate unqualified column names (if at all possible)
1739 for my $alias (keys %$alias2src) {
1740 my $rsrc = $alias2src->{$alias};
1741 for my $colname ($rsrc->columns) {
1742 push @{$seen_cols{$colname}}, $alias;
1747 foreach my $col (@$colnames) {
1748 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1751 # see if the column was seen exactly once (so we know which rsrc it came from)
1752 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1753 $alias = $seen_cols{$colname}[0];
1760 my $rsrc = $alias2src->{$alias};
1761 $return{$col} = $rsrc && {
1762 %{$rsrc->column_info($colname)},
1763 -result_source => $rsrc,
1764 -source_alias => $alias,
1771 # Returns a counting SELECT for a simple count
1772 # query. Abstracted so that a storage could override
1773 # this to { count => 'firstcol' } or whatever makes
1774 # sense as a performance optimization
1776 #my ($self, $source, $rs_attrs) = @_;
1777 return { count => '*' };
1780 # Returns a SELECT which will end up in the subselect
1781 # There may or may not be a group_by, as the subquery
1782 # might have been called to accomodate a limit
1784 # Most databases would be happy with whatever ends up
1785 # here, but some choke in various ways.
1787 sub _subq_count_select {
1788 my ($self, $source, $rs_attrs) = @_;
1789 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1791 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1792 return @pcols ? \@pcols : [ 1 ];
1796 sub source_bind_attributes {
1797 my ($self, $source) = @_;
1799 my $bind_attributes;
1800 foreach my $column ($source->columns) {
1802 my $data_type = $source->column_info($column)->{data_type} || '';
1803 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1807 return $bind_attributes;
1814 =item Arguments: $ident, $select, $condition, $attrs
1818 Handle a SQL select statement.
1824 my ($ident, $select, $condition, $attrs) = @_;
1825 return $self->cursor_class->new($self, \@_, $attrs);
1830 my ($rv, $sth, @bind) = $self->_select(@_);
1831 my @row = $sth->fetchrow_array;
1832 my @nextrow = $sth->fetchrow_array if @row;
1833 if(@row && @nextrow) {
1834 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1836 # Need to call finish() to work round broken DBDs
1845 =item Arguments: $sql
1849 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1854 my ($self, $dbh, $sql) = @_;
1856 # 3 is the if_active parameter which avoids active sth re-use
1857 my $sth = $self->disable_sth_caching
1858 ? $dbh->prepare($sql)
1859 : $dbh->prepare_cached($sql, {}, 3);
1861 # XXX You would think RaiseError would make this impossible,
1862 # but apparently that's not true :(
1863 $self->throw_exception($dbh->errstr) if !$sth;
1869 my ($self, $sql) = @_;
1870 $self->dbh_do('_dbh_sth', $sql);
1873 sub _dbh_columns_info_for {
1874 my ($self, $dbh, $table) = @_;
1876 if ($dbh->can('column_info')) {
1879 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1880 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1882 while ( my $info = $sth->fetchrow_hashref() ){
1884 $column_info{data_type} = $info->{TYPE_NAME};
1885 $column_info{size} = $info->{COLUMN_SIZE};
1886 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1887 $column_info{default_value} = $info->{COLUMN_DEF};
1888 my $col_name = $info->{COLUMN_NAME};
1889 $col_name =~ s/^\"(.*)\"$/$1/;
1891 $result{$col_name} = \%column_info;
1894 return \%result if !$@ && scalar keys %result;
1898 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1900 my @columns = @{$sth->{NAME_lc}};
1901 for my $i ( 0 .. $#columns ){
1903 $column_info{data_type} = $sth->{TYPE}->[$i];
1904 $column_info{size} = $sth->{PRECISION}->[$i];
1905 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1907 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1908 $column_info{data_type} = $1;
1909 $column_info{size} = $2;
1912 $result{$columns[$i]} = \%column_info;
1916 foreach my $col (keys %result) {
1917 my $colinfo = $result{$col};
1918 my $type_num = $colinfo->{data_type};
1920 if(defined $type_num && $dbh->can('type_info')) {
1921 my $type_info = $dbh->type_info($type_num);
1922 $type_name = $type_info->{TYPE_NAME} if $type_info;
1923 $colinfo->{data_type} = $type_name if $type_name;
1930 sub columns_info_for {
1931 my ($self, $table) = @_;
1932 $self->dbh_do('_dbh_columns_info_for', $table);
1935 =head2 last_insert_id
1937 Return the row id of the last insert.
1941 sub _dbh_last_insert_id {
1942 # All Storage's need to register their own _dbh_last_insert_id
1943 # the old SQLite-based method was highly inappropriate
1946 my $class = ref $self;
1947 $self->throw_exception (<<EOE);
1949 No _dbh_last_insert_id() method found in $class.
1950 Since the method of obtaining the autoincrement id of the last insert
1951 operation varies greatly between different databases, this method must be
1952 individually implemented for every storage class.
1956 sub last_insert_id {
1958 $self->dbh_do('_dbh_last_insert_id', @_);
1963 Returns the database driver name.
1967 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1969 =head2 bind_attribute_by_data_type
1971 Given a datatype from column info, returns a database specific bind
1972 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1973 let the database planner just handle it.
1975 Generally only needed for special case column types, like bytea in postgres.
1979 sub bind_attribute_by_data_type {
1983 =head2 is_datatype_numeric
1985 Given a datatype from column_info, returns a boolean value indicating if
1986 the current RDBMS considers it a numeric value. This controls how
1987 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1988 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1989 be performed instead of the usual C<eq>.
1993 sub is_datatype_numeric {
1994 my ($self, $dt) = @_;
1996 return 0 unless $dt;
1998 return $dt =~ /^ (?:
1999 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2004 =head2 create_ddl_dir (EXPERIMENTAL)
2008 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2012 Creates a SQL file based on the Schema, for each of the specified
2013 database engines in C<\@databases> in the given directory.
2014 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2016 Given a previous version number, this will also create a file containing
2017 the ALTER TABLE statements to transform the previous schema into the
2018 current one. Note that these statements may contain C<DROP TABLE> or
2019 C<DROP COLUMN> statements that can potentially destroy data.
2021 The file names are created using the C<ddl_filename> method below, please
2022 override this method in your schema if you would like a different file
2023 name format. For the ALTER file, the same format is used, replacing
2024 $version in the name with "$preversion-$version".
2026 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2027 The most common value for this would be C<< { add_drop_table => 1 } >>
2028 to have the SQL produced include a C<DROP TABLE> statement for each table
2029 created. For quoting purposes supply C<quote_table_names> and
2030 C<quote_field_names>.
2032 If no arguments are passed, then the following default values are assumed:
2036 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2038 =item version - $schema->schema_version
2040 =item directory - './'
2042 =item preversion - <none>
2046 By default, C<\%sqlt_args> will have
2048 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2050 merged with the hash passed in. To disable any of those features, pass in a
2051 hashref like the following
2053 { ignore_constraint_names => 0, # ... other options }
2056 Note that this feature is currently EXPERIMENTAL and may not work correctly
2057 across all databases, or fully handle complex relationships.
2059 WARNING: Please check all SQL files created, before applying them.
2063 sub create_ddl_dir {
2064 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2066 if(!$dir || !-d $dir) {
2067 carp "No directory given, using ./\n";
2070 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2071 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2073 my $schema_version = $schema->schema_version || '1.x';
2074 $version ||= $schema_version;
2077 add_drop_table => 1,
2078 ignore_constraint_names => 1,
2079 ignore_index_names => 1,
2083 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2084 . $self->_check_sqlt_message . q{'})
2085 if !$self->_check_sqlt_version;
2087 my $sqlt = SQL::Translator->new( $sqltargs );
2089 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2090 my $sqlt_schema = $sqlt->translate({ data => $schema })
2091 or $self->throw_exception ($sqlt->error);
2093 foreach my $db (@$databases) {
2095 $sqlt->{schema} = $sqlt_schema;
2096 $sqlt->producer($db);
2099 my $filename = $schema->ddl_filename($db, $version, $dir);
2100 if (-e $filename && ($version eq $schema_version )) {
2101 # if we are dumping the current version, overwrite the DDL
2102 carp "Overwriting existing DDL file - $filename";
2106 my $output = $sqlt->translate;
2108 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2111 if(!open($file, ">$filename")) {
2112 $self->throw_exception("Can't open $filename for writing ($!)");
2115 print $file $output;
2118 next unless ($preversion);
2120 require SQL::Translator::Diff;
2122 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2123 if(!-e $prefilename) {
2124 carp("No previous schema file found ($prefilename)");
2128 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2130 carp("Overwriting existing diff file - $difffile");
2136 my $t = SQL::Translator->new($sqltargs);
2141 or $self->throw_exception ($t->error);
2143 my $out = $t->translate( $prefilename )
2144 or $self->throw_exception ($t->error);
2146 $source_schema = $t->schema;
2148 $source_schema->name( $prefilename )
2149 unless ( $source_schema->name );
2152 # The "new" style of producers have sane normalization and can support
2153 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2154 # And we have to diff parsed SQL against parsed SQL.
2155 my $dest_schema = $sqlt_schema;
2157 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2158 my $t = SQL::Translator->new($sqltargs);
2163 or $self->throw_exception ($t->error);
2165 my $out = $t->translate( $filename )
2166 or $self->throw_exception ($t->error);
2168 $dest_schema = $t->schema;
2170 $dest_schema->name( $filename )
2171 unless $dest_schema->name;
2174 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2178 if(!open $file, ">$difffile") {
2179 $self->throw_exception("Can't write to $difffile ($!)");
2187 =head2 deployment_statements
2191 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2195 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2197 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2198 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2200 C<$directory> is used to return statements from files in a previously created
2201 L</create_ddl_dir> directory and is optional. The filenames are constructed
2202 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2204 If no C<$directory> is specified then the statements are constructed on the
2205 fly using L<SQL::Translator> and C<$version> is ignored.
2207 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2211 sub deployment_statements {
2212 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2213 # Need to be connected to get the correct sqlt_type
2214 $self->ensure_connected() unless $type;
2215 $type ||= $self->sqlt_type;
2216 $version ||= $schema->schema_version || '1.x';
2218 my $filename = $schema->ddl_filename($type, $version, $dir);
2222 open($file, "<$filename")
2223 or $self->throw_exception("Can't open $filename ($!)");
2226 return join('', @rows);
2229 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2230 . $self->_check_sqlt_message . q{'})
2231 if !$self->_check_sqlt_version;
2233 require SQL::Translator::Parser::DBIx::Class;
2234 eval qq{use SQL::Translator::Producer::${type}};
2235 $self->throw_exception($@) if $@;
2237 # sources needs to be a parser arg, but for simplicty allow at top level
2239 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2240 if exists $sqltargs->{sources};
2242 my $tr = SQL::Translator->new(%$sqltargs);
2243 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2244 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2248 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2251 return if($line =~ /^--/);
2253 # next if($line =~ /^DROP/m);
2254 return if($line =~ /^BEGIN TRANSACTION/m);
2255 return if($line =~ /^COMMIT/m);
2256 return if $line =~ /^\s+$/; # skip whitespace only
2257 $self->_query_start($line);
2259 $self->dbh->do($line); # shouldn't be using ->dbh ?
2262 carp qq{$@ (running "${line}")};
2264 $self->_query_end($line);
2266 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2267 if (@statements > 1) {
2268 foreach my $statement (@statements) {
2269 $deploy->( $statement );
2272 elsif (@statements == 1) {
2273 foreach my $line ( split(";\n", $statements[0])) {
2279 =head2 datetime_parser
2281 Returns the datetime parser class
2285 sub datetime_parser {
2287 return $self->{datetime_parser} ||= do {
2288 $self->ensure_connected;
2289 $self->build_datetime_parser(@_);
2293 =head2 datetime_parser_type
2295 Defines (returns) the datetime parser class - currently hardwired to
2296 L<DateTime::Format::MySQL>
2300 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2302 =head2 build_datetime_parser
2304 See L</datetime_parser>
2308 sub build_datetime_parser {
2310 my $type = $self->datetime_parser_type(@_);
2312 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2317 my $_check_sqlt_version; # private
2318 my $_check_sqlt_message; # private
2319 sub _check_sqlt_version {
2320 return $_check_sqlt_version if defined $_check_sqlt_version;
2321 eval 'use SQL::Translator "0.09003"';
2322 $_check_sqlt_message = $@ || '';
2323 $_check_sqlt_version = !$@;
2326 sub _check_sqlt_message {
2327 _check_sqlt_version if !defined $_check_sqlt_message;
2328 $_check_sqlt_message;
2332 =head2 is_replicating
2334 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2335 replicate from a master database. Default is undef, which is the result
2336 returned by databases that don't support replication.
2340 sub is_replicating {
2345 =head2 lag_behind_master
2347 Returns a number that represents a certain amount of lag behind a master db
2348 when a given storage is replicating. The number is database dependent, but
2349 starts at zero and increases with the amount of lag. Default in undef
2353 sub lag_behind_master {
2357 =head2 order_columns_for_select
2359 Returns an ordered list of column names for use with a C<SELECT> when the column
2360 list is not explicitly specified.
2361 By default returns the result of L<DBIx::Class::ResultSource/columns>.
2363 This may be overridden in a specific storage when there are requirements such
2364 as moving C<BLOB> columns to the end of the list.
2368 sub order_columns_for_select {
2369 my ($self, $source, $columns) = @_;
2376 return if !$self->_dbh;
2385 =head2 DBIx::Class and AutoCommit
2387 DBIx::Class can do some wonderful magic with handling exceptions,
2388 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2389 combined with C<txn_do> for transaction support.
2391 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2392 in an assumed transaction between commits, and you're telling us you'd
2393 like to manage that manually. A lot of the magic protections offered by
2394 this module will go away. We can't protect you from exceptions due to database
2395 disconnects because we don't know anything about how to restart your
2396 transactions. You're on your own for handling all sorts of exceptional
2397 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2404 Matt S. Trout <mst@shadowcatsystems.co.uk>
2406 Andy Grundman <andy@hybridized.org>
2410 You may distribute this code under the same terms as Perl itself.