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 if (ref $args[0] eq 'CODE') {
441 # _connect() never looks past $args[0] in this case
444 %attrs = (%{ $self->_dbi_connect_attributes }, %attrs);
447 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
448 $self->_connect_info;
451 sub _dbi_connect_attributes {
452 return { AutoCommit => 1 };
457 This method is deprecated in favour of setting via L</connect_info>.
461 =head2 on_disconnect_do
463 This method is deprecated in favour of setting via L</connect_info>.
467 sub _parse_connect_do {
468 my ($self, $type) = @_;
470 my $val = $self->$type;
471 return () if not defined $val;
476 push @res, [ 'do_sql', $val ];
477 } elsif (ref($val) eq 'CODE') {
479 } elsif (ref($val) eq 'ARRAY') {
480 push @res, map { [ 'do_sql', $_ ] } @$val;
482 $self->throw_exception("Invalid type for $type: ".ref($val));
490 Arguments: ($subref | $method_name), @extra_coderef_args?
492 Execute the given $subref or $method_name using the new exception-based
493 connection management.
495 The first two arguments will be the storage object that C<dbh_do> was called
496 on and a database handle to use. Any additional arguments will be passed
497 verbatim to the called subref as arguments 2 and onwards.
499 Using this (instead of $self->_dbh or $self->dbh) ensures correct
500 exception handling and reconnection (or failover in future subclasses).
502 Your subref should have no side-effects outside of the database, as
503 there is the potential for your subref to be partially double-executed
504 if the database connection was stale/dysfunctional.
508 my @stuff = $schema->storage->dbh_do(
510 my ($storage, $dbh, @cols) = @_;
511 my $cols = join(q{, }, @cols);
512 $dbh->selectrow_array("SELECT $cols FROM foo");
523 my $dbh = $self->_dbh;
525 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
526 || $self->{transaction_depth};
528 local $self->{_in_dbh_do} = 1;
531 my $want_array = wantarray;
534 $self->_verify_pid if $dbh;
536 $self->_populate_dbh;
541 @result = $self->$code($dbh, @_);
543 elsif(defined $want_array) {
544 $result[0] = $self->$code($dbh, @_);
547 $self->$code($dbh, @_);
552 if(!$exception) { return $want_array ? @result : $result[0] }
554 $self->throw_exception($exception) if $self->connected;
556 # We were not connected - reconnect and retry, but let any
557 # exception fall right through this time
558 $self->_populate_dbh;
559 $self->$code($self->_dbh, @_);
562 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
563 # It also informs dbh_do to bypass itself while under the direction of txn_do,
564 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
569 ref $coderef eq 'CODE' or $self->throw_exception
570 ('$coderef must be a CODE reference');
572 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
574 local $self->{_in_dbh_do} = 1;
577 my $want_array = wantarray;
582 $self->_verify_pid if $self->_dbh;
583 $self->_populate_dbh if !$self->_dbh;
587 @result = $coderef->(@_);
589 elsif(defined $want_array) {
590 $result[0] = $coderef->(@_);
599 if(!$exception) { return $want_array ? @result : $result[0] }
601 if($tried++ > 0 || $self->connected) {
602 eval { $self->txn_rollback };
603 my $rollback_exception = $@;
604 if($rollback_exception) {
605 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
606 $self->throw_exception($exception) # propagate nested rollback
607 if $rollback_exception =~ /$exception_class/;
609 $self->throw_exception(
610 "Transaction aborted: ${exception}. "
611 . "Rollback failed: ${rollback_exception}"
614 $self->throw_exception($exception)
617 # We were not connected, and was first try - reconnect and retry
619 $self->_populate_dbh;
625 Our C<disconnect> method also performs a rollback first if the
626 database is not in C<AutoCommit> mode.
636 push @actions, ( $self->on_disconnect_call || () );
637 push @actions, $self->_parse_connect_do ('on_disconnect_do');
639 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
641 $self->_dbh->rollback unless $self->_dbh_autocommit;
642 $self->_dbh->disconnect;
648 =head2 with_deferred_fk_checks
652 =item Arguments: C<$coderef>
654 =item Return Value: The return value of $coderef
658 Storage specific method to run the code ref with FK checks deferred or
659 in MySQL's case disabled entirely.
663 # Storage subclasses should override this
664 sub with_deferred_fk_checks {
665 my ($self, $sub) = @_;
673 if(my $dbh = $self->_dbh) {
674 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
681 return 0 if !$self->_dbh;
683 return ($dbh->FETCH('Active') && $self->_ping);
692 my $dbh = $self->_dbh or return 0;
697 # handle pid changes correctly
698 # NOTE: assumes $self->_dbh is a valid $dbh
702 return if defined $self->_conn_pid && $self->_conn_pid == $$;
704 $self->_dbh->{InactiveDestroy} = 1;
711 sub ensure_connected {
714 unless ($self->connected) {
715 $self->_populate_dbh;
721 Returns the dbh - a data base handle of class L<DBI>.
728 if (not $self->_dbh) {
729 $self->_populate_dbh;
731 $self->ensure_connected;
739 if (not $self->_dbh) {
740 $self->_populate_dbh;
745 sub _sql_maker_args {
750 array_datatypes => 1,
751 limit_dialect => $self->_get_dbh,
752 %{$self->_sql_maker_opts}
758 unless ($self->_sql_maker) {
759 my $sql_maker_class = $self->sql_maker_class;
760 $self->ensure_class_loaded ($sql_maker_class);
761 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
763 return $self->_sql_maker;
771 my @info = @{$self->_dbi_connect_info || []};
772 $self->_dbh($self->_connect(@info));
774 $self->_conn_pid($$);
775 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
777 $self->_determine_driver;
779 # Always set the transaction depth on connect, since
780 # there is no transaction in progress by definition
781 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
783 $self->_run_connection_actions unless $self->{_in_determine_driver};
786 sub _run_connection_actions {
790 push @actions, ( $self->on_connect_call || () );
791 push @actions, $self->_parse_connect_do ('on_connect_do');
793 $self->_do_connection_actions(connect_call_ => $_) for @actions;
796 sub _determine_driver {
799 if (not $self->_driver_determined) {
800 my $started_unconnected = 0;
801 local $self->{_in_determine_driver} = 1;
803 if (ref($self) eq __PACKAGE__) {
805 if ($self->_dbh) { # we are connected
806 $driver = $self->_dbh->{Driver}{Name};
808 # try to use dsn to not require being connected, the driver may still
809 # force a connection in _rebless to determine version
810 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
811 $started_unconnected = 1;
814 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
815 if ($self->load_optional_class($storage_class)) {
816 mro::set_mro($storage_class, 'c3');
817 bless $self, $storage_class;
822 $self->_driver_determined(1);
824 $self->_run_connection_actions
825 if $started_unconnected && defined $self->_dbh;
829 sub _do_connection_actions {
831 my $method_prefix = shift;
834 if (not ref($call)) {
835 my $method = $method_prefix . $call;
837 } elsif (ref($call) eq 'CODE') {
839 } elsif (ref($call) eq 'ARRAY') {
840 if (ref($call->[0]) ne 'ARRAY') {
841 $self->_do_connection_actions($method_prefix, $_) for @$call;
843 $self->_do_connection_actions($method_prefix, @$_) for @$call;
846 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
852 sub connect_call_do_sql {
854 $self->_do_query(@_);
857 sub disconnect_call_do_sql {
859 $self->_do_query(@_);
862 # override in db-specific backend when necessary
863 sub connect_call_datetime_setup { 1 }
866 my ($self, $action) = @_;
868 if (ref $action eq 'CODE') {
869 $action = $action->($self);
870 $self->_do_query($_) foreach @$action;
873 # Most debuggers expect ($sql, @bind), so we need to exclude
874 # the attribute hash which is the second argument to $dbh->do
875 # furthermore the bind values are usually to be presented
876 # as named arrayref pairs, so wrap those here too
877 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
878 my $sql = shift @do_args;
879 my $attrs = shift @do_args;
880 my @bind = map { [ undef, $_ ] } @do_args;
882 $self->_query_start($sql, @bind);
883 $self->_dbh->do($sql, $attrs, @do_args);
884 $self->_query_end($sql, @bind);
891 my ($self, @info) = @_;
893 $self->throw_exception("You failed to provide any connection info")
896 my ($old_connect_via, $dbh);
898 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
899 $old_connect_via = $DBI::connect_via;
900 $DBI::connect_via = 'connect';
904 if(ref $info[0] eq 'CODE') {
908 $dbh = DBI->connect(@info);
911 if($dbh && !$self->unsafe) {
912 my $weak_self = $self;
913 Scalar::Util::weaken($weak_self);
914 $dbh->{HandleError} = sub {
916 $weak_self->throw_exception("DBI Exception: $_[0]");
919 croak ("DBI Exception: $_[0]");
922 $dbh->{ShowErrorStatement} = 1;
923 $dbh->{RaiseError} = 1;
924 $dbh->{PrintError} = 0;
928 $DBI::connect_via = $old_connect_via if $old_connect_via;
930 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
933 $self->_dbh_autocommit($dbh->{AutoCommit});
939 my ($self, $name) = @_;
941 $name = $self->_svp_generate_name
942 unless defined $name;
944 $self->throw_exception ("You can't use savepoints outside a transaction")
945 if $self->{transaction_depth} == 0;
947 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
948 unless $self->can('_svp_begin');
950 push @{ $self->{savepoints} }, $name;
952 $self->debugobj->svp_begin($name) if $self->debug;
954 return $self->_svp_begin($name);
958 my ($self, $name) = @_;
960 $self->throw_exception ("You can't use savepoints outside a transaction")
961 if $self->{transaction_depth} == 0;
963 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
964 unless $self->can('_svp_release');
967 $self->throw_exception ("Savepoint '$name' does not exist")
968 unless grep { $_ eq $name } @{ $self->{savepoints} };
970 # Dig through the stack until we find the one we are releasing. This keeps
971 # the stack up to date.
974 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
976 $name = pop @{ $self->{savepoints} };
979 $self->debugobj->svp_release($name) if $self->debug;
981 return $self->_svp_release($name);
985 my ($self, $name) = @_;
987 $self->throw_exception ("You can't use savepoints outside a transaction")
988 if $self->{transaction_depth} == 0;
990 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
991 unless $self->can('_svp_rollback');
994 # If they passed us a name, verify that it exists in the stack
995 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
996 $self->throw_exception("Savepoint '$name' does not exist!");
999 # Dig through the stack until we find the one we are releasing. This keeps
1000 # the stack up to date.
1001 while(my $s = pop(@{ $self->{savepoints} })) {
1002 last if($s eq $name);
1004 # Add the savepoint back to the stack, as a rollback doesn't remove the
1005 # named savepoint, only everything after it.
1006 push(@{ $self->{savepoints} }, $name);
1008 # We'll assume they want to rollback to the last savepoint
1009 $name = $self->{savepoints}->[-1];
1012 $self->debugobj->svp_rollback($name) if $self->debug;
1014 return $self->_svp_rollback($name);
1017 sub _svp_generate_name {
1020 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1025 if($self->{transaction_depth} == 0) {
1026 $self->debugobj->txn_begin()
1028 # this isn't ->_dbh-> because
1029 # we should reconnect on begin_work
1030 # for AutoCommit users
1031 $self->dbh_do(sub { $_[1]->begin_work });
1032 } elsif ($self->auto_savepoint) {
1035 $self->{transaction_depth}++;
1040 if ($self->{transaction_depth} == 1) {
1041 my $dbh = $self->_dbh;
1042 $self->debugobj->txn_commit()
1045 $self->{transaction_depth} = 0
1046 if $self->_dbh_autocommit;
1048 elsif($self->{transaction_depth} > 1) {
1049 $self->{transaction_depth}--;
1051 if $self->auto_savepoint;
1057 my $dbh = $self->_dbh;
1059 if ($self->{transaction_depth} == 1) {
1060 $self->debugobj->txn_rollback()
1062 $self->{transaction_depth} = 0
1063 if $self->_dbh_autocommit;
1066 elsif($self->{transaction_depth} > 1) {
1067 $self->{transaction_depth}--;
1068 if ($self->auto_savepoint) {
1069 $self->svp_rollback;
1074 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1079 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1080 $error =~ /$exception_class/ and $self->throw_exception($error);
1081 # ensure that a failed rollback resets the transaction depth
1082 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1083 $self->throw_exception($error);
1087 # This used to be the top-half of _execute. It was split out to make it
1088 # easier to override in NoBindVars without duping the rest. It takes up
1089 # all of _execute's args, and emits $sql, @bind.
1090 sub _prep_for_execute {
1091 my ($self, $op, $extra_bind, $ident, $args) = @_;
1093 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1094 $ident = $ident->from();
1097 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1100 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1102 return ($sql, \@bind);
1106 sub _fix_bind_params {
1107 my ($self, @bind) = @_;
1109 ### Turn @bind from something like this:
1110 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1112 ### ( "'1'", "'1'", "'3'" )
1115 if ( defined( $_ && $_->[1] ) ) {
1116 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1123 my ( $self, $sql, @bind ) = @_;
1125 if ( $self->debug ) {
1126 @bind = $self->_fix_bind_params(@bind);
1128 $self->debugobj->query_start( $sql, @bind );
1133 my ( $self, $sql, @bind ) = @_;
1135 if ( $self->debug ) {
1136 @bind = $self->_fix_bind_params(@bind);
1137 $self->debugobj->query_end( $sql, @bind );
1142 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1144 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1146 $self->_query_start( $sql, @$bind );
1148 my $sth = $self->sth($sql,$op);
1150 my $placeholder_index = 1;
1152 foreach my $bound (@$bind) {
1153 my $attributes = {};
1154 my($column_name, @data) = @$bound;
1156 if ($bind_attributes) {
1157 $attributes = $bind_attributes->{$column_name}
1158 if defined $bind_attributes->{$column_name};
1161 foreach my $data (@data) {
1162 my $ref = ref $data;
1163 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1165 $sth->bind_param($placeholder_index, $data, $attributes);
1166 $placeholder_index++;
1170 # Can this fail without throwing an exception anyways???
1171 my $rv = $sth->execute();
1172 $self->throw_exception($sth->errstr) if !$rv;
1174 $self->_query_end( $sql, @$bind );
1176 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1181 $self->dbh_do('_dbh_execute', @_)
1185 my ($self, $source, $to_insert) = @_;
1187 # redispatch to insert method of storage we reblessed into, if necessary
1188 if (not $self->_driver_determined) {
1189 $self->_determine_driver;
1190 goto $self->can('insert');
1193 my $ident = $source->from;
1194 my $bind_attributes = $self->source_bind_attributes($source);
1196 my $updated_cols = {};
1198 foreach my $col ( $source->columns ) {
1199 if ( !defined $to_insert->{$col} ) {
1200 my $col_info = $source->column_info($col);
1202 if ( $col_info->{auto_nextval} ) {
1203 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1205 $col_info->{sequence} ||
1206 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1212 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1214 return $updated_cols;
1217 ## Still not quite perfect, and EXPERIMENTAL
1218 ## Currently it is assumed that all values passed will be "normal", i.e. not
1219 ## scalar refs, or at least, all the same type as the first set, the statement is
1220 ## only prepped once.
1222 my ($self, $source, $cols, $data) = @_;
1224 my $table = $source->from;
1225 @colvalues{@$cols} = (0..$#$cols);
1226 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1228 $self->_determine_driver;
1230 $self->_query_start( $sql, @bind );
1231 my $sth = $self->sth($sql);
1233 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1235 ## This must be an arrayref, else nothing works!
1236 my $tuple_status = [];
1238 ## Get the bind_attributes, if any exist
1239 my $bind_attributes = $self->source_bind_attributes($source);
1241 ## Bind the values and execute
1242 my $placeholder_index = 1;
1244 foreach my $bound (@bind) {
1246 my $attributes = {};
1247 my ($column_name, $data_index) = @$bound;
1249 if( $bind_attributes ) {
1250 $attributes = $bind_attributes->{$column_name}
1251 if defined $bind_attributes->{$column_name};
1254 my @data = map { $_->[$data_index] } @$data;
1256 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1257 $placeholder_index++;
1259 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1262 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1264 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1265 if ($i > $#$tuple_status);
1267 require Data::Dumper;
1268 local $Data::Dumper::Terse = 1;
1269 local $Data::Dumper::Indent = 1;
1270 local $Data::Dumper::Useqq = 1;
1271 local $Data::Dumper::Quotekeys = 0;
1273 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1274 $tuple_status->[$i][1],
1275 Data::Dumper::Dumper(
1276 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1280 $self->throw_exception($sth->errstr) if !$rv;
1282 $self->_query_end( $sql, @bind );
1283 return (wantarray ? ($rv, $sth, @bind) : $rv);
1287 my $self = shift @_;
1288 my $source = shift @_;
1289 $self->_determine_driver;
1290 my $bind_attributes = $self->source_bind_attributes($source);
1292 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1297 my $self = shift @_;
1298 my $source = shift @_;
1299 $self->_determine_driver;
1300 my $bind_attrs = $self->source_bind_attributes($source);
1302 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1305 # We were sent here because the $rs contains a complex search
1306 # which will require a subquery to select the correct rows
1307 # (i.e. joined or limited resultsets)
1309 # Genarating a single PK column subquery is trivial and supported
1310 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1311 # Look at _multipk_update_delete()
1312 sub _subq_update_delete {
1314 my ($rs, $op, $values) = @_;
1316 my $rsrc = $rs->result_source;
1318 # we already check this, but double check naively just in case. Should be removed soon
1319 my $sel = $rs->_resolved_attrs->{select};
1320 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1321 my @pcols = $rsrc->primary_columns;
1322 if (@$sel != @pcols) {
1323 $self->throw_exception (
1324 'Subquery update/delete can not be called on resultsets selecting a'
1325 .' number of columns different than the number of primary keys'
1332 $op eq 'update' ? $values : (),
1333 { $pcols[0] => { -in => $rs->as_query } },
1338 return $self->_multipk_update_delete (@_);
1342 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1343 # resultset update/delete involving subqueries. So by default resort
1344 # to simple (and inefficient) delete_all style per-row opearations,
1345 # while allowing specific storages to override this with a faster
1348 sub _multipk_update_delete {
1349 return shift->_per_row_update_delete (@_);
1352 # This is the default loop used to delete/update rows for multi PK
1353 # resultsets, and used by mysql exclusively (because it can't do anything
1356 # We do not use $row->$op style queries, because resultset update/delete
1357 # is not expected to cascade (this is what delete_all/update_all is for).
1359 # There should be no race conditions as the entire operation is rolled
1362 sub _per_row_update_delete {
1364 my ($rs, $op, $values) = @_;
1366 my $rsrc = $rs->result_source;
1367 my @pcols = $rsrc->primary_columns;
1369 my $guard = $self->txn_scope_guard;
1371 # emulate the return value of $sth->execute for non-selects
1372 my $row_cnt = '0E0';
1374 my $subrs_cur = $rs->cursor;
1375 while (my @pks = $subrs_cur->next) {
1378 for my $i (0.. $#pcols) {
1379 $cond->{$pcols[$i]} = $pks[$i];
1384 $op eq 'update' ? $values : (),
1399 # localization is neccessary as
1400 # 1) there is no infrastructure to pass this around before SQLA2
1401 # 2) _select_args sets it and _prep_for_execute consumes it
1402 my $sql_maker = $self->sql_maker;
1403 local $sql_maker->{_dbic_rs_attrs};
1405 return $self->_execute($self->_select_args(@_));
1408 sub _select_args_to_query {
1411 # localization is neccessary as
1412 # 1) there is no infrastructure to pass this around before SQLA2
1413 # 2) _select_args sets it and _prep_for_execute consumes it
1414 my $sql_maker = $self->sql_maker;
1415 local $sql_maker->{_dbic_rs_attrs};
1417 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1418 # = $self->_select_args($ident, $select, $cond, $attrs);
1419 my ($op, $bind, $ident, $bind_attrs, @args) =
1420 $self->_select_args(@_);
1422 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1423 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1424 $prepared_bind ||= [];
1427 ? ($sql, $prepared_bind, $bind_attrs)
1428 : \[ "($sql)", @$prepared_bind ]
1433 my ($self, $ident, $select, $where, $attrs) = @_;
1435 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1437 my $sql_maker = $self->sql_maker;
1438 $sql_maker->{_dbic_rs_attrs} = {
1444 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1449 # calculate bind_attrs before possible $ident mangling
1450 my $bind_attrs = {};
1451 for my $alias (keys %$alias2source) {
1452 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1453 for my $col (keys %$bindtypes) {
1455 my $fqcn = join ('.', $alias, $col);
1456 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1458 # Unqialified column names are nice, but at the same time can be
1459 # rather ambiguous. What we do here is basically go along with
1460 # the loop, adding an unqualified column slot to $bind_attrs,
1461 # alongside the fully qualified name. As soon as we encounter
1462 # another column by that name (which would imply another table)
1463 # we unset the unqualified slot and never add any info to it
1464 # to avoid erroneous type binding. If this happens the users
1465 # only choice will be to fully qualify his column name
1467 if (exists $bind_attrs->{$col}) {
1468 $bind_attrs->{$col} = {};
1471 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1478 $attrs->{software_limit}
1480 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1482 $attrs->{software_limit} = 1;
1485 $self->throw_exception("rows attribute must be positive if present")
1486 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1488 # MySQL actually recommends this approach. I cringe.
1489 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1494 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1495 # otherwise delegate the limiting to the storage, unless software limit was requested
1497 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1499 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1500 $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1502 ($ident, $select, $where, $attrs)
1503 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1505 elsif (! $attrs->{software_limit} ) {
1506 push @limit, $attrs->{rows}, $attrs->{offset};
1510 # This would be the point to deflate anything found in $where
1511 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1512 # expect a row object. And all we have is a resultsource (it is trivial
1513 # to extract deflator coderefs via $alias2source above).
1515 # I don't see a way forward other than changing the way deflators are
1516 # invoked, and that's just bad...
1520 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1521 (qw/order_by group_by having/ )
1524 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1528 # This is the code producing joined subqueries like:
1529 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1531 sub _adjust_select_args_for_complex_prefetch {
1532 my ($self, $from, $select, $where, $attrs) = @_;
1534 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1535 if (ref $from ne 'ARRAY');
1537 # copies for mangling
1539 $select = [ @$select ];
1540 $attrs = { %$attrs };
1542 # separate attributes
1543 my $sub_attrs = { %$attrs };
1544 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1545 delete $sub_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1547 my $select_root_alias = $attrs->{alias};
1548 my $sql_maker = $self->sql_maker;
1550 # create subquery select list - consider only stuff *not* brought in by the prefetch
1551 my $sub_select = [];
1553 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{_prefetch_select}} - 1) {
1554 my $sel = $attrs->{select}[$i];
1556 # alias any functions to the dbic-side 'as' label
1557 # adjust the outer select accordingly
1558 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1559 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1560 $select->[$i] = join ('.', $attrs->{alias}, ($attrs->{as}[$i] || "select_$i") );
1563 push @$sub_select, $sel;
1566 # bring over all non-collapse-induced order_by into the inner query (if any)
1567 # the outer one will have to keep them all
1568 delete $sub_attrs->{order_by};
1569 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1570 $sub_attrs->{order_by} = [
1571 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1575 # mangle {from}, keep in mind that $from is "headless" from here on
1576 my $join_root = shift @$from;
1579 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1581 # in complex search_related chains $select_root_alias may *not* be
1582 # 'me' so always include it in the inner join
1583 $inner_joins{$select_root_alias} = 1 if ($join_root->{-alias} ne $select_root_alias);
1586 # decide which parts of the join will remain on the inside
1588 # this is not a very viable optimisation, but it was written
1589 # before I realised this, so might as well remain. We can throw
1590 # away _any_ branches of the join tree that are:
1591 # 1) not mentioned in the condition/order
1592 # 2) left-join leaves (or left-join leaf chains)
1593 # Most of the join conditions will not satisfy this, but for real
1594 # complex queries some might, and we might make some RDBMS happy.
1597 # since we do not have introspectable SQLA, we fall back to ugly
1598 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1599 # in order to determine what goes into %inner_joins
1600 # It may not be very efficient, but it's a reasonable stop-gap
1602 # produce stuff unquoted, so it can be scanned
1603 local $sql_maker->{quote_char};
1604 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1608 { ref $_ ? $_->[0] : $_ }
1609 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1612 my $where_sql = $sql_maker->where ($where);
1613 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1616 for my $alias (keys %join_info) {
1618 # any table alias found on a column name in where or order_by
1619 # gets included in %inner_joins
1620 # Also any parent joins that are needed to reach this particular alias
1621 for my $piece ($select_sql, $where_sql, @order_by ) {
1622 if ($piece =~ /\b $alias $sep/x) {
1623 $inner_joins{$alias} = 1;
1629 # scan for non-leaf/non-left joins and mark as needed
1630 # also mark all ancestor joins that are needed to reach this particular alias
1631 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1633 # traverse by the size of the -join_path i.e. reverse depth first
1634 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1636 my $j = $join_info{$alias};
1637 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1639 if ($inner_joins{$alias}) {
1640 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1644 # construct the inner $from for the subquery
1645 my $inner_from = [ $join_root ];
1646 for my $j (@$from) {
1647 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1650 # if a multi-type join was needed in the subquery ("multi" is indicated by
1651 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1652 unless ($sub_attrs->{group_by}) {
1653 for my $alias (keys %inner_joins) {
1655 # the dot comes from some weirdness in collapse
1656 # remove after the rewrite
1657 if ($attrs->{collapse}{".$alias"}) {
1658 $sub_attrs->{group_by} ||= $sub_select;
1664 # generate the subquery
1665 my $subq = $self->_select_args_to_query (
1671 my $subq_joinspec = {
1672 -alias => $select_root_alias,
1673 -source_handle => $join_root->{-source_handle},
1674 $select_root_alias => $subq,
1677 # Generate a new from (really just replace the join slot with the subquery)
1678 # Before we would start the outer chain from the subquery itself (i.e.
1679 # SELECT ... FROM (SELECT ... ) alias JOIN ..., but this turned out to be
1680 # a bad idea for search_related, as the root of the chain was effectively
1681 # lost (i.e. $artist_rs->search_related ('cds'... ) would result in alias
1682 # of 'cds', which would prevent from doing things like order_by artist.*)
1683 # See t/prefetch/via_search_related.t for a better idea
1685 if ($join_root->{-alias} eq $select_root_alias) { # just swap the root part and we're done
1691 else { # this is trickier
1692 @outer_from = ($join_root);
1694 for my $j (@$from) {
1695 if ($j->[0]{-alias} eq $select_root_alias) {
1702 push @outer_from, $j;
1707 # This is totally horrific - the $where ends up in both the inner and outer query
1708 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1709 # then if where conditions apply to the *right* side of the prefetch, you may have
1710 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1711 # the outer select to exclude joins you didin't want in the first place
1713 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1714 return (\@outer_from, $select, $where, $attrs);
1717 sub _resolve_ident_sources {
1718 my ($self, $ident) = @_;
1720 my $alias2source = {};
1723 # the reason this is so contrived is that $ident may be a {from}
1724 # structure, specifying multiple tables to join
1725 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1726 # this is compat mode for insert/update/delete which do not deal with aliases
1727 $alias2source->{me} = $ident;
1730 elsif (ref $ident eq 'ARRAY') {
1734 if (ref $_ eq 'HASH') {
1736 $rs_alias = $tabinfo->{-alias};
1738 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1742 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1743 if ($tabinfo->{-source_handle});
1747 return ($alias2source, $rs_alias);
1750 # Takes $ident, \@column_names
1752 # returns { $column_name => \%column_info, ... }
1753 # also note: this adds -result_source => $rsrc to the column info
1756 # my $col_sources = $self->_resolve_column_info($ident, @column_names);
1757 sub _resolve_column_info {
1758 my ($self, $ident, $colnames) = @_;
1759 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1761 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1764 my (%return, %seen_cols);
1766 # compile a global list of column names, to be able to properly
1767 # disambiguate unqualified column names (if at all possible)
1768 for my $alias (keys %$alias2src) {
1769 my $rsrc = $alias2src->{$alias};
1770 for my $colname ($rsrc->columns) {
1771 push @{$seen_cols{$colname}}, $alias;
1776 foreach my $col (@$colnames) {
1777 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1780 # see if the column was seen exactly once (so we know which rsrc it came from)
1781 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1782 $alias = $seen_cols{$colname}[0];
1789 my $rsrc = $alias2src->{$alias};
1790 $return{$col} = $rsrc && {
1791 %{$rsrc->column_info($colname)},
1792 -result_source => $rsrc,
1793 -source_alias => $alias,
1800 # Returns a counting SELECT for a simple count
1801 # query. Abstracted so that a storage could override
1802 # this to { count => 'firstcol' } or whatever makes
1803 # sense as a performance optimization
1805 #my ($self, $source, $rs_attrs) = @_;
1806 return { count => '*' };
1809 # Returns a SELECT which will end up in the subselect
1810 # There may or may not be a group_by, as the subquery
1811 # might have been called to accomodate a limit
1813 # Most databases would be happy with whatever ends up
1814 # here, but some choke in various ways.
1816 sub _subq_count_select {
1817 my ($self, $source, $rs_attrs) = @_;
1818 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1820 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1821 return @pcols ? \@pcols : [ 1 ];
1825 sub source_bind_attributes {
1826 my ($self, $source) = @_;
1828 my $bind_attributes;
1829 foreach my $column ($source->columns) {
1831 my $data_type = $source->column_info($column)->{data_type} || '';
1832 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1836 return $bind_attributes;
1843 =item Arguments: $ident, $select, $condition, $attrs
1847 Handle a SQL select statement.
1853 my ($ident, $select, $condition, $attrs) = @_;
1854 return $self->cursor_class->new($self, \@_, $attrs);
1859 my ($rv, $sth, @bind) = $self->_select(@_);
1860 my @row = $sth->fetchrow_array;
1861 my @nextrow = $sth->fetchrow_array if @row;
1862 if(@row && @nextrow) {
1863 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1865 # Need to call finish() to work round broken DBDs
1874 =item Arguments: $sql
1878 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1883 my ($self, $dbh, $sql) = @_;
1885 # 3 is the if_active parameter which avoids active sth re-use
1886 my $sth = $self->disable_sth_caching
1887 ? $dbh->prepare($sql)
1888 : $dbh->prepare_cached($sql, {}, 3);
1890 # XXX You would think RaiseError would make this impossible,
1891 # but apparently that's not true :(
1892 $self->throw_exception($dbh->errstr) if !$sth;
1898 my ($self, $sql) = @_;
1899 $self->dbh_do('_dbh_sth', $sql);
1902 sub _dbh_columns_info_for {
1903 my ($self, $dbh, $table) = @_;
1905 if ($dbh->can('column_info')) {
1908 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1909 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1911 while ( my $info = $sth->fetchrow_hashref() ){
1913 $column_info{data_type} = $info->{TYPE_NAME};
1914 $column_info{size} = $info->{COLUMN_SIZE};
1915 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1916 $column_info{default_value} = $info->{COLUMN_DEF};
1917 my $col_name = $info->{COLUMN_NAME};
1918 $col_name =~ s/^\"(.*)\"$/$1/;
1920 $result{$col_name} = \%column_info;
1923 return \%result if !$@ && scalar keys %result;
1927 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1929 my @columns = @{$sth->{NAME_lc}};
1930 for my $i ( 0 .. $#columns ){
1932 $column_info{data_type} = $sth->{TYPE}->[$i];
1933 $column_info{size} = $sth->{PRECISION}->[$i];
1934 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1936 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1937 $column_info{data_type} = $1;
1938 $column_info{size} = $2;
1941 $result{$columns[$i]} = \%column_info;
1945 foreach my $col (keys %result) {
1946 my $colinfo = $result{$col};
1947 my $type_num = $colinfo->{data_type};
1949 if(defined $type_num && $dbh->can('type_info')) {
1950 my $type_info = $dbh->type_info($type_num);
1951 $type_name = $type_info->{TYPE_NAME} if $type_info;
1952 $colinfo->{data_type} = $type_name if $type_name;
1959 sub columns_info_for {
1960 my ($self, $table) = @_;
1961 $self->dbh_do('_dbh_columns_info_for', $table);
1964 =head2 last_insert_id
1966 Return the row id of the last insert.
1970 sub _dbh_last_insert_id {
1971 # All Storage's need to register their own _dbh_last_insert_id
1972 # the old SQLite-based method was highly inappropriate
1975 my $class = ref $self;
1976 $self->throw_exception (<<EOE);
1978 No _dbh_last_insert_id() method found in $class.
1979 Since the method of obtaining the autoincrement id of the last insert
1980 operation varies greatly between different databases, this method must be
1981 individually implemented for every storage class.
1985 sub last_insert_id {
1987 $self->dbh_do('_dbh_last_insert_id', @_);
1992 Returns the database driver name.
1996 sub sqlt_type { shift->_get_dbh->{Driver}->{Name} }
1998 =head2 bind_attribute_by_data_type
2000 Given a datatype from column info, returns a database specific bind
2001 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2002 let the database planner just handle it.
2004 Generally only needed for special case column types, like bytea in postgres.
2008 sub bind_attribute_by_data_type {
2012 =head2 is_datatype_numeric
2014 Given a datatype from column_info, returns a boolean value indicating if
2015 the current RDBMS considers it a numeric value. This controls how
2016 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2017 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2018 be performed instead of the usual C<eq>.
2022 sub is_datatype_numeric {
2023 my ($self, $dt) = @_;
2025 return 0 unless $dt;
2027 return $dt =~ /^ (?:
2028 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2033 =head2 create_ddl_dir (EXPERIMENTAL)
2037 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2041 Creates a SQL file based on the Schema, for each of the specified
2042 database engines in C<\@databases> in the given directory.
2043 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2045 Given a previous version number, this will also create a file containing
2046 the ALTER TABLE statements to transform the previous schema into the
2047 current one. Note that these statements may contain C<DROP TABLE> or
2048 C<DROP COLUMN> statements that can potentially destroy data.
2050 The file names are created using the C<ddl_filename> method below, please
2051 override this method in your schema if you would like a different file
2052 name format. For the ALTER file, the same format is used, replacing
2053 $version in the name with "$preversion-$version".
2055 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2056 The most common value for this would be C<< { add_drop_table => 1 } >>
2057 to have the SQL produced include a C<DROP TABLE> statement for each table
2058 created. For quoting purposes supply C<quote_table_names> and
2059 C<quote_field_names>.
2061 If no arguments are passed, then the following default values are assumed:
2065 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2067 =item version - $schema->schema_version
2069 =item directory - './'
2071 =item preversion - <none>
2075 By default, C<\%sqlt_args> will have
2077 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2079 merged with the hash passed in. To disable any of those features, pass in a
2080 hashref like the following
2082 { ignore_constraint_names => 0, # ... other options }
2085 Note that this feature is currently EXPERIMENTAL and may not work correctly
2086 across all databases, or fully handle complex relationships.
2088 WARNING: Please check all SQL files created, before applying them.
2092 sub create_ddl_dir {
2093 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2095 if(!$dir || !-d $dir) {
2096 carp "No directory given, using ./\n";
2099 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2100 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2102 my $schema_version = $schema->schema_version || '1.x';
2103 $version ||= $schema_version;
2106 add_drop_table => 1,
2107 ignore_constraint_names => 1,
2108 ignore_index_names => 1,
2112 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2113 . $self->_check_sqlt_message . q{'})
2114 if !$self->_check_sqlt_version;
2116 my $sqlt = SQL::Translator->new( $sqltargs );
2118 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2119 my $sqlt_schema = $sqlt->translate({ data => $schema })
2120 or $self->throw_exception ($sqlt->error);
2122 foreach my $db (@$databases) {
2124 $sqlt->{schema} = $sqlt_schema;
2125 $sqlt->producer($db);
2128 my $filename = $schema->ddl_filename($db, $version, $dir);
2129 if (-e $filename && ($version eq $schema_version )) {
2130 # if we are dumping the current version, overwrite the DDL
2131 carp "Overwriting existing DDL file - $filename";
2135 my $output = $sqlt->translate;
2137 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2140 if(!open($file, ">$filename")) {
2141 $self->throw_exception("Can't open $filename for writing ($!)");
2144 print $file $output;
2147 next unless ($preversion);
2149 require SQL::Translator::Diff;
2151 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2152 if(!-e $prefilename) {
2153 carp("No previous schema file found ($prefilename)");
2157 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2159 carp("Overwriting existing diff file - $difffile");
2165 my $t = SQL::Translator->new($sqltargs);
2170 or $self->throw_exception ($t->error);
2172 my $out = $t->translate( $prefilename )
2173 or $self->throw_exception ($t->error);
2175 $source_schema = $t->schema;
2177 $source_schema->name( $prefilename )
2178 unless ( $source_schema->name );
2181 # The "new" style of producers have sane normalization and can support
2182 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2183 # And we have to diff parsed SQL against parsed SQL.
2184 my $dest_schema = $sqlt_schema;
2186 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2187 my $t = SQL::Translator->new($sqltargs);
2192 or $self->throw_exception ($t->error);
2194 my $out = $t->translate( $filename )
2195 or $self->throw_exception ($t->error);
2197 $dest_schema = $t->schema;
2199 $dest_schema->name( $filename )
2200 unless $dest_schema->name;
2203 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2207 if(!open $file, ">$difffile") {
2208 $self->throw_exception("Can't write to $difffile ($!)");
2216 =head2 deployment_statements
2220 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2224 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2226 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2227 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2229 C<$directory> is used to return statements from files in a previously created
2230 L</create_ddl_dir> directory and is optional. The filenames are constructed
2231 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2233 If no C<$directory> is specified then the statements are constructed on the
2234 fly using L<SQL::Translator> and C<$version> is ignored.
2236 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2240 sub deployment_statements {
2241 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2242 # Need to be connected to get the correct sqlt_type
2243 $self->_get_dbh() unless $type;
2244 $type ||= $self->sqlt_type;
2245 $version ||= $schema->schema_version || '1.x';
2247 my $filename = $schema->ddl_filename($type, $version, $dir);
2251 open($file, "<$filename")
2252 or $self->throw_exception("Can't open $filename ($!)");
2255 return join('', @rows);
2258 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2259 . $self->_check_sqlt_message . q{'})
2260 if !$self->_check_sqlt_version;
2262 require SQL::Translator::Parser::DBIx::Class;
2263 eval qq{use SQL::Translator::Producer::${type}};
2264 $self->throw_exception($@) if $@;
2266 # sources needs to be a parser arg, but for simplicty allow at top level
2268 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2269 if exists $sqltargs->{sources};
2271 my $tr = SQL::Translator->new(%$sqltargs);
2272 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2273 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2277 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2280 return if($line =~ /^--/);
2282 # next if($line =~ /^DROP/m);
2283 return if($line =~ /^BEGIN TRANSACTION/m);
2284 return if($line =~ /^COMMIT/m);
2285 return if $line =~ /^\s+$/; # skip whitespace only
2286 $self->_query_start($line);
2288 $self->_get_dbh->do($line);
2291 carp qq{$@ (running "${line}")};
2293 $self->_query_end($line);
2295 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2296 if (@statements > 1) {
2297 foreach my $statement (@statements) {
2298 $deploy->( $statement );
2301 elsif (@statements == 1) {
2302 foreach my $line ( split(";\n", $statements[0])) {
2308 =head2 datetime_parser
2310 Returns the datetime parser class
2314 sub datetime_parser {
2316 return $self->{datetime_parser} ||= do {
2318 $self->build_datetime_parser(@_);
2322 =head2 datetime_parser_type
2324 Defines (returns) the datetime parser class - currently hardwired to
2325 L<DateTime::Format::MySQL>
2329 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2331 =head2 build_datetime_parser
2333 See L</datetime_parser>
2337 sub build_datetime_parser {
2339 my $type = $self->datetime_parser_type(@_);
2341 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2346 my $_check_sqlt_version; # private
2347 my $_check_sqlt_message; # private
2348 sub _check_sqlt_version {
2349 return $_check_sqlt_version if defined $_check_sqlt_version;
2350 eval 'use SQL::Translator "0.09003"';
2351 $_check_sqlt_message = $@ || '';
2352 $_check_sqlt_version = !$@;
2355 sub _check_sqlt_message {
2356 _check_sqlt_version if !defined $_check_sqlt_message;
2357 $_check_sqlt_message;
2361 =head2 is_replicating
2363 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2364 replicate from a master database. Default is undef, which is the result
2365 returned by databases that don't support replication.
2369 sub is_replicating {
2374 =head2 lag_behind_master
2376 Returns a number that represents a certain amount of lag behind a master db
2377 when a given storage is replicating. The number is database dependent, but
2378 starts at zero and increases with the amount of lag. Default in undef
2382 sub lag_behind_master {
2388 return if !$self->_dbh;
2397 =head2 DBIx::Class and AutoCommit
2399 DBIx::Class can do some wonderful magic with handling exceptions,
2400 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2401 combined with C<txn_do> for transaction support.
2403 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2404 in an assumed transaction between commits, and you're telling us you'd
2405 like to manage that manually. A lot of the magic protections offered by
2406 this module will go away. We can't protect you from exceptions due to database
2407 disconnects because we don't know anything about how to restart your
2408 transactions. You're on your own for handling all sorts of exceptional
2409 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2416 Matt S. Trout <mst@shadowcatsystems.co.uk>
2418 Andy Grundman <andy@hybridized.org>
2422 You may distribute this code under the same terms as Perl itself.