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
19 _conn_pid _conn_tid transaction_depth _dbh_autocommit 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 (ref $self eq 'DBIx::Class::Storage::DBI') {
801 my $started_unconnected = 0;
802 local $self->{_in_determine_driver} = 1;
804 if ($self->_dbh) { # we are connected
805 $driver = $self->_dbh->{Driver}{Name};
807 # try to use dsn to not require being connected, the driver may still
808 # force a connection in _rebless to determine version
809 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
810 $started_unconnected = 1;
813 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
814 if ($self->load_optional_class($storage_class)) {
815 mro::set_mro($storage_class, 'c3');
816 bless $self, $storage_class;
820 $self->_run_connection_actions if $started_unconnected;
824 sub _do_connection_actions {
826 my $method_prefix = shift;
829 if (not ref($call)) {
830 my $method = $method_prefix . $call;
832 } elsif (ref($call) eq 'CODE') {
834 } elsif (ref($call) eq 'ARRAY') {
835 if (ref($call->[0]) ne 'ARRAY') {
836 $self->_do_connection_actions($method_prefix, $_) for @$call;
838 $self->_do_connection_actions($method_prefix, @$_) for @$call;
841 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
847 sub connect_call_do_sql {
849 $self->_do_query(@_);
852 sub disconnect_call_do_sql {
854 $self->_do_query(@_);
857 # override in db-specific backend when necessary
858 sub connect_call_datetime_setup { 1 }
861 my ($self, $action) = @_;
863 if (ref $action eq 'CODE') {
864 $action = $action->($self);
865 $self->_do_query($_) foreach @$action;
868 # Most debuggers expect ($sql, @bind), so we need to exclude
869 # the attribute hash which is the second argument to $dbh->do
870 # furthermore the bind values are usually to be presented
871 # as named arrayref pairs, so wrap those here too
872 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
873 my $sql = shift @do_args;
874 my $attrs = shift @do_args;
875 my @bind = map { [ undef, $_ ] } @do_args;
877 $self->_query_start($sql, @bind);
878 $self->_dbh->do($sql, $attrs, @do_args);
879 $self->_query_end($sql, @bind);
886 my ($self, @info) = @_;
888 $self->throw_exception("You failed to provide any connection info")
891 my ($old_connect_via, $dbh);
893 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
894 $old_connect_via = $DBI::connect_via;
895 $DBI::connect_via = 'connect';
899 if(ref $info[0] eq 'CODE') {
903 $dbh = DBI->connect(@info);
906 if($dbh && !$self->unsafe) {
907 my $weak_self = $self;
908 Scalar::Util::weaken($weak_self);
909 $dbh->{HandleError} = sub {
911 $weak_self->throw_exception("DBI Exception: $_[0]");
914 croak ("DBI Exception: $_[0]");
917 $dbh->{ShowErrorStatement} = 1;
918 $dbh->{RaiseError} = 1;
919 $dbh->{PrintError} = 0;
923 $DBI::connect_via = $old_connect_via if $old_connect_via;
925 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
928 $self->_dbh_autocommit($dbh->{AutoCommit});
934 my ($self, $name) = @_;
936 $name = $self->_svp_generate_name
937 unless defined $name;
939 $self->throw_exception ("You can't use savepoints outside a transaction")
940 if $self->{transaction_depth} == 0;
942 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
943 unless $self->can('_svp_begin');
945 push @{ $self->{savepoints} }, $name;
947 $self->debugobj->svp_begin($name) if $self->debug;
949 return $self->_svp_begin($name);
953 my ($self, $name) = @_;
955 $self->throw_exception ("You can't use savepoints outside a transaction")
956 if $self->{transaction_depth} == 0;
958 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
959 unless $self->can('_svp_release');
962 $self->throw_exception ("Savepoint '$name' does not exist")
963 unless grep { $_ eq $name } @{ $self->{savepoints} };
965 # Dig through the stack until we find the one we are releasing. This keeps
966 # the stack up to date.
969 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
971 $name = pop @{ $self->{savepoints} };
974 $self->debugobj->svp_release($name) if $self->debug;
976 return $self->_svp_release($name);
980 my ($self, $name) = @_;
982 $self->throw_exception ("You can't use savepoints outside a transaction")
983 if $self->{transaction_depth} == 0;
985 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
986 unless $self->can('_svp_rollback');
989 # If they passed us a name, verify that it exists in the stack
990 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
991 $self->throw_exception("Savepoint '$name' does not exist!");
994 # Dig through the stack until we find the one we are releasing. This keeps
995 # the stack up to date.
996 while(my $s = pop(@{ $self->{savepoints} })) {
997 last if($s eq $name);
999 # Add the savepoint back to the stack, as a rollback doesn't remove the
1000 # named savepoint, only everything after it.
1001 push(@{ $self->{savepoints} }, $name);
1003 # We'll assume they want to rollback to the last savepoint
1004 $name = $self->{savepoints}->[-1];
1007 $self->debugobj->svp_rollback($name) if $self->debug;
1009 return $self->_svp_rollback($name);
1012 sub _svp_generate_name {
1015 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1020 if($self->{transaction_depth} == 0) {
1021 $self->debugobj->txn_begin()
1023 # this isn't ->_dbh-> because
1024 # we should reconnect on begin_work
1025 # for AutoCommit users
1026 $self->dbh_do(sub { $_[1]->begin_work });
1027 } elsif ($self->auto_savepoint) {
1030 $self->{transaction_depth}++;
1035 if ($self->{transaction_depth} == 1) {
1036 my $dbh = $self->_dbh;
1037 $self->debugobj->txn_commit()
1040 $self->{transaction_depth} = 0
1041 if $self->_dbh_autocommit;
1043 elsif($self->{transaction_depth} > 1) {
1044 $self->{transaction_depth}--;
1046 if $self->auto_savepoint;
1052 my $dbh = $self->_dbh;
1054 if ($self->{transaction_depth} == 1) {
1055 $self->debugobj->txn_rollback()
1057 $self->{transaction_depth} = 0
1058 if $self->_dbh_autocommit;
1061 elsif($self->{transaction_depth} > 1) {
1062 $self->{transaction_depth}--;
1063 if ($self->auto_savepoint) {
1064 $self->svp_rollback;
1069 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1074 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1075 $error =~ /$exception_class/ and $self->throw_exception($error);
1076 # ensure that a failed rollback resets the transaction depth
1077 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1078 $self->throw_exception($error);
1082 # This used to be the top-half of _execute. It was split out to make it
1083 # easier to override in NoBindVars without duping the rest. It takes up
1084 # all of _execute's args, and emits $sql, @bind.
1085 sub _prep_for_execute {
1086 my ($self, $op, $extra_bind, $ident, $args) = @_;
1088 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1089 $ident = $ident->from();
1092 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1095 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1097 return ($sql, \@bind);
1101 sub _fix_bind_params {
1102 my ($self, @bind) = @_;
1104 ### Turn @bind from something like this:
1105 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1107 ### ( "'1'", "'1'", "'3'" )
1110 if ( defined( $_ && $_->[1] ) ) {
1111 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1118 my ( $self, $sql, @bind ) = @_;
1120 if ( $self->debug ) {
1121 @bind = $self->_fix_bind_params(@bind);
1123 $self->debugobj->query_start( $sql, @bind );
1128 my ( $self, $sql, @bind ) = @_;
1130 if ( $self->debug ) {
1131 @bind = $self->_fix_bind_params(@bind);
1132 $self->debugobj->query_end( $sql, @bind );
1137 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1139 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1141 $self->_query_start( $sql, @$bind );
1143 my $sth = $self->sth($sql,$op);
1145 my $placeholder_index = 1;
1147 foreach my $bound (@$bind) {
1148 my $attributes = {};
1149 my($column_name, @data) = @$bound;
1151 if ($bind_attributes) {
1152 $attributes = $bind_attributes->{$column_name}
1153 if defined $bind_attributes->{$column_name};
1156 foreach my $data (@data) {
1157 my $ref = ref $data;
1158 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1160 $sth->bind_param($placeholder_index, $data, $attributes);
1161 $placeholder_index++;
1165 # Can this fail without throwing an exception anyways???
1166 my $rv = $sth->execute();
1167 $self->throw_exception($sth->errstr) if !$rv;
1169 $self->_query_end( $sql, @$bind );
1171 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1176 $self->dbh_do('_dbh_execute', @_)
1180 my ($self, $source, $to_insert) = @_;
1182 $self->_determine_driver;
1184 my $ident = $source->from;
1185 my $bind_attributes = $self->source_bind_attributes($source);
1187 my $updated_cols = {};
1189 foreach my $col ( $source->columns ) {
1190 if ( !defined $to_insert->{$col} ) {
1191 my $col_info = $source->column_info($col);
1193 if ( $col_info->{auto_nextval} ) {
1194 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1196 $col_info->{sequence} ||
1197 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1203 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1205 return $updated_cols;
1208 ## Still not quite perfect, and EXPERIMENTAL
1209 ## Currently it is assumed that all values passed will be "normal", i.e. not
1210 ## scalar refs, or at least, all the same type as the first set, the statement is
1211 ## only prepped once.
1213 my ($self, $source, $cols, $data) = @_;
1215 my $table = $source->from;
1216 @colvalues{@$cols} = (0..$#$cols);
1217 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1219 $self->_determine_driver;
1221 $self->_query_start( $sql, @bind );
1222 my $sth = $self->sth($sql);
1224 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1226 ## This must be an arrayref, else nothing works!
1227 my $tuple_status = [];
1229 ## Get the bind_attributes, if any exist
1230 my $bind_attributes = $self->source_bind_attributes($source);
1232 ## Bind the values and execute
1233 my $placeholder_index = 1;
1235 foreach my $bound (@bind) {
1237 my $attributes = {};
1238 my ($column_name, $data_index) = @$bound;
1240 if( $bind_attributes ) {
1241 $attributes = $bind_attributes->{$column_name}
1242 if defined $bind_attributes->{$column_name};
1245 my @data = map { $_->[$data_index] } @$data;
1247 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1248 $placeholder_index++;
1250 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1253 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1255 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1256 if ($i > $#$tuple_status);
1258 require Data::Dumper;
1259 local $Data::Dumper::Terse = 1;
1260 local $Data::Dumper::Indent = 1;
1261 local $Data::Dumper::Useqq = 1;
1262 local $Data::Dumper::Quotekeys = 0;
1264 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1265 $tuple_status->[$i][1],
1266 Data::Dumper::Dumper(
1267 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1271 $self->throw_exception($sth->errstr) if !$rv;
1273 $self->_query_end( $sql, @bind );
1274 return (wantarray ? ($rv, $sth, @bind) : $rv);
1278 my $self = shift @_;
1279 my $source = shift @_;
1280 $self->_determine_driver;
1281 my $bind_attributes = $self->source_bind_attributes($source);
1283 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1288 my $self = shift @_;
1289 my $source = shift @_;
1290 $self->_determine_driver;
1291 my $bind_attrs = $self->source_bind_attributes($source);
1293 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1296 # We were sent here because the $rs contains a complex search
1297 # which will require a subquery to select the correct rows
1298 # (i.e. joined or limited resultsets)
1300 # Genarating a single PK column subquery is trivial and supported
1301 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1302 # Look at _multipk_update_delete()
1303 sub _subq_update_delete {
1305 my ($rs, $op, $values) = @_;
1307 my $rsrc = $rs->result_source;
1309 # we already check this, but double check naively just in case. Should be removed soon
1310 my $sel = $rs->_resolved_attrs->{select};
1311 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1312 my @pcols = $rsrc->primary_columns;
1313 if (@$sel != @pcols) {
1314 $self->throw_exception (
1315 'Subquery update/delete can not be called on resultsets selecting a'
1316 .' number of columns different than the number of primary keys'
1323 $op eq 'update' ? $values : (),
1324 { $pcols[0] => { -in => $rs->as_query } },
1329 return $self->_multipk_update_delete (@_);
1333 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1334 # resultset update/delete involving subqueries. So by default resort
1335 # to simple (and inefficient) delete_all style per-row opearations,
1336 # while allowing specific storages to override this with a faster
1339 sub _multipk_update_delete {
1340 return shift->_per_row_update_delete (@_);
1343 # This is the default loop used to delete/update rows for multi PK
1344 # resultsets, and used by mysql exclusively (because it can't do anything
1347 # We do not use $row->$op style queries, because resultset update/delete
1348 # is not expected to cascade (this is what delete_all/update_all is for).
1350 # There should be no race conditions as the entire operation is rolled
1353 sub _per_row_update_delete {
1355 my ($rs, $op, $values) = @_;
1357 my $rsrc = $rs->result_source;
1358 my @pcols = $rsrc->primary_columns;
1360 my $guard = $self->txn_scope_guard;
1362 # emulate the return value of $sth->execute for non-selects
1363 my $row_cnt = '0E0';
1365 my $subrs_cur = $rs->cursor;
1366 while (my @pks = $subrs_cur->next) {
1369 for my $i (0.. $#pcols) {
1370 $cond->{$pcols[$i]} = $pks[$i];
1375 $op eq 'update' ? $values : (),
1390 # localization is neccessary as
1391 # 1) there is no infrastructure to pass this around before SQLA2
1392 # 2) _select_args sets it and _prep_for_execute consumes it
1393 my $sql_maker = $self->sql_maker;
1394 local $sql_maker->{_dbic_rs_attrs};
1396 return $self->_execute($self->_select_args(@_));
1399 sub _select_args_to_query {
1402 # localization is neccessary as
1403 # 1) there is no infrastructure to pass this around before SQLA2
1404 # 2) _select_args sets it and _prep_for_execute consumes it
1405 my $sql_maker = $self->sql_maker;
1406 local $sql_maker->{_dbic_rs_attrs};
1408 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1409 # = $self->_select_args($ident, $select, $cond, $attrs);
1410 my ($op, $bind, $ident, $bind_attrs, @args) =
1411 $self->_select_args(@_);
1413 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1414 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1415 $prepared_bind ||= [];
1418 ? ($sql, $prepared_bind, $bind_attrs)
1419 : \[ "($sql)", @$prepared_bind ]
1424 my ($self, $ident, $select, $where, $attrs) = @_;
1426 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1428 my $sql_maker = $self->sql_maker;
1429 $sql_maker->{_dbic_rs_attrs} = {
1435 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1440 # calculate bind_attrs before possible $ident mangling
1441 my $bind_attrs = {};
1442 for my $alias (keys %$alias2source) {
1443 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1444 for my $col (keys %$bindtypes) {
1446 my $fqcn = join ('.', $alias, $col);
1447 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1449 # so that unqualified searches can be bound too
1450 $bind_attrs->{$col} = $bind_attrs->{$fqcn} if $alias eq $rs_alias;
1456 $attrs->{software_limit}
1458 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1460 $attrs->{software_limit} = 1;
1463 $self->throw_exception("rows attribute must be positive if present")
1464 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1466 # MySQL actually recommends this approach. I cringe.
1467 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1472 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1473 # otherwise delegate the limiting to the storage, unless software limit was requested
1475 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1477 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1478 $attrs->{prefetch_select} && @{$attrs->{prefetch_select}} )
1480 ($ident, $select, $where, $attrs)
1481 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1483 elsif (! $attrs->{software_limit} ) {
1484 push @limit, $attrs->{rows}, $attrs->{offset};
1488 # This would be the point to deflate anything found in $where
1489 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1490 # expect a row object. And all we have is a resultsource (it is trivial
1491 # to extract deflator coderefs via $alias2source above).
1493 # I don't see a way forward other than changing the way deflators are
1494 # invoked, and that's just bad...
1498 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1499 (qw/order_by group_by having/ )
1502 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1506 # This is the code producing joined subqueries like:
1507 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1509 sub _adjust_select_args_for_complex_prefetch {
1510 my ($self, $from, $select, $where, $attrs) = @_;
1512 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1513 if (ref $from ne 'ARRAY');
1515 # copies for mangling
1517 $select = [ @$select ];
1518 $attrs = { %$attrs };
1520 # separate attributes
1521 my $sub_attrs = { %$attrs };
1522 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1523 delete $sub_attrs->{$_} for qw/for collapse prefetch_select _collapse_order_by select as/;
1525 my $alias = $attrs->{alias};
1526 my $sql_maker = $self->sql_maker;
1528 # create subquery select list - consider only stuff *not* brought in by the prefetch
1529 my $sub_select = [];
1530 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{prefetch_select}} - 1) {
1531 my $sel = $attrs->{select}[$i];
1533 # alias any functions to the dbic-side 'as' label
1534 # adjust the outer select accordingly
1535 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1536 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1537 $select->[$i] = join ('.', $attrs->{alias}, ($attrs->{as}[$i] || "select_$i") );
1540 push @$sub_select, $sel;
1543 # bring over all non-collapse-induced order_by into the inner query (if any)
1544 # the outer one will have to keep them all
1545 delete $sub_attrs->{order_by};
1546 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1547 $sub_attrs->{order_by} = [
1548 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1553 my $join_root = shift @$from;
1554 my @outer_from = @$from;
1557 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1559 # in complex search_related chains $alias may *not* be 'me'
1560 # so always include it in the inner join, and also shift away
1561 # from the outer stack, so that the two datasets actually do
1563 if ($join_root->{-alias} ne $alias) {
1564 $inner_joins{$alias} = 1;
1566 while (@outer_from && $outer_from[0][0]{-alias} ne $alias) {
1569 if (! @outer_from) {
1570 $self->throw_exception ("Unable to find '$alias' in the {from} stack, something is wrong");
1573 shift @outer_from; # the new subquery will represent this alias, so get rid of it
1577 # decide which parts of the join will remain on the inside
1579 # this is not a very viable optimisation, but it was written
1580 # before I realised this, so might as well remain. We can throw
1581 # away _any_ branches of the join tree that are:
1582 # 1) not mentioned in the condition/order
1583 # 2) left-join leaves (or left-join leaf chains)
1584 # Most of the join conditions will not satisfy this, but for real
1585 # complex queries some might, and we might make some RDBMS happy.
1588 # since we do not have introspectable SQLA, we fall back to ugly
1589 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1590 # in order to determine what goes into %inner_joins
1591 # It may not be very efficient, but it's a reasonable stop-gap
1593 # produce stuff unquoted, so it can be scanned
1594 local $sql_maker->{quote_char};
1595 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1599 { ref $_ ? $_->[0] : $_ }
1600 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1603 my $where_sql = $sql_maker->where ($where);
1604 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1607 for my $alias (keys %join_info) {
1609 # any table alias found on a column name in where or order_by
1610 # gets included in %inner_joins
1611 # Also any parent joins that are needed to reach this particular alias
1612 for my $piece ($select_sql, $where_sql, @order_by ) {
1613 if ($piece =~ /\b $alias $sep/x) {
1614 $inner_joins{$alias} = 1;
1620 # scan for non-leaf/non-left joins and mark as needed
1621 # also mark all ancestor joins that are needed to reach this particular alias
1622 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1624 # traverse by the size of the -join_path i.e. reverse depth first
1625 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1627 my $j = $join_info{$alias};
1628 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1630 if ($inner_joins{$alias}) {
1631 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1635 # construct the inner $from for the subquery
1636 my $inner_from = [ $join_root ];
1637 for my $j (@$from) {
1638 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1641 # if a multi-type join was needed in the subquery ("multi" is indicated by
1642 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1643 for my $alias (keys %inner_joins) {
1645 # the dot comes from some weirdness in collapse
1646 # remove after the rewrite
1647 if ($attrs->{collapse}{".$alias"}) {
1648 $sub_attrs->{group_by} ||= $sub_select;
1653 # generate the subquery
1654 my $subq = $self->_select_args_to_query (
1661 # put it in the new {from}
1662 unshift @outer_from, {
1664 -source_handle => $join_root->{-source_handle},
1668 # This is totally horrific - the $where ends up in both the inner and outer query
1669 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1670 # then if where conditions apply to the *right* side of the prefetch, you may have
1671 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1672 # the outer select to exclude joins you didin't want in the first place
1674 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1675 return (\@outer_from, $select, $where, $attrs);
1678 sub _resolve_ident_sources {
1679 my ($self, $ident) = @_;
1681 my $alias2source = {};
1684 # the reason this is so contrived is that $ident may be a {from}
1685 # structure, specifying multiple tables to join
1686 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1687 # this is compat mode for insert/update/delete which do not deal with aliases
1688 $alias2source->{me} = $ident;
1691 elsif (ref $ident eq 'ARRAY') {
1695 if (ref $_ eq 'HASH') {
1697 $rs_alias = $tabinfo->{-alias};
1699 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1703 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1704 if ($tabinfo->{-source_handle});
1708 return ($alias2source, $rs_alias);
1711 # Takes $ident, \@column_names
1713 # returns { $column_name => \%column_info, ... }
1714 # also note: this adds -result_source => $rsrc to the column info
1717 # my $col_sources = $self->_resolve_column_info($ident, [map $_->[0], @{$bind}]);
1718 sub _resolve_column_info {
1719 my ($self, $ident, $colnames) = @_;
1720 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1722 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1725 my (%return, %converted);
1726 foreach my $col (@$colnames) {
1727 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1729 # deal with unqualified cols - we assume the main alias for all
1730 # unqualified ones, ugly but can't think of anything better right now
1731 $alias ||= $root_alias;
1733 my $rsrc = $alias2src->{$alias};
1734 $return{$col} = $rsrc && { %{$rsrc->column_info($colname)}, -result_source => $rsrc };
1739 # Returns a counting SELECT for a simple count
1740 # query. Abstracted so that a storage could override
1741 # this to { count => 'firstcol' } or whatever makes
1742 # sense as a performance optimization
1744 #my ($self, $source, $rs_attrs) = @_;
1745 return { count => '*' };
1748 # Returns a SELECT which will end up in the subselect
1749 # There may or may not be a group_by, as the subquery
1750 # might have been called to accomodate a limit
1752 # Most databases would be happy with whatever ends up
1753 # here, but some choke in various ways.
1755 sub _subq_count_select {
1756 my ($self, $source, $rs_attrs) = @_;
1757 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1759 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1760 return @pcols ? \@pcols : [ 1 ];
1764 sub source_bind_attributes {
1765 my ($self, $source) = @_;
1767 my $bind_attributes;
1768 foreach my $column ($source->columns) {
1770 my $data_type = $source->column_info($column)->{data_type} || '';
1771 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1775 return $bind_attributes;
1782 =item Arguments: $ident, $select, $condition, $attrs
1786 Handle a SQL select statement.
1792 my ($ident, $select, $condition, $attrs) = @_;
1793 return $self->cursor_class->new($self, \@_, $attrs);
1798 my ($rv, $sth, @bind) = $self->_select(@_);
1799 my @row = $sth->fetchrow_array;
1800 my @nextrow = $sth->fetchrow_array if @row;
1801 if(@row && @nextrow) {
1802 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1804 # Need to call finish() to work round broken DBDs
1813 =item Arguments: $sql
1817 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1822 my ($self, $dbh, $sql) = @_;
1824 # 3 is the if_active parameter which avoids active sth re-use
1825 my $sth = $self->disable_sth_caching
1826 ? $dbh->prepare($sql)
1827 : $dbh->prepare_cached($sql, {}, 3);
1829 # XXX You would think RaiseError would make this impossible,
1830 # but apparently that's not true :(
1831 $self->throw_exception($dbh->errstr) if !$sth;
1837 my ($self, $sql) = @_;
1838 $self->dbh_do('_dbh_sth', $sql);
1841 sub _dbh_columns_info_for {
1842 my ($self, $dbh, $table) = @_;
1844 if ($dbh->can('column_info')) {
1847 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1848 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1850 while ( my $info = $sth->fetchrow_hashref() ){
1852 $column_info{data_type} = $info->{TYPE_NAME};
1853 $column_info{size} = $info->{COLUMN_SIZE};
1854 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1855 $column_info{default_value} = $info->{COLUMN_DEF};
1856 my $col_name = $info->{COLUMN_NAME};
1857 $col_name =~ s/^\"(.*)\"$/$1/;
1859 $result{$col_name} = \%column_info;
1862 return \%result if !$@ && scalar keys %result;
1866 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1868 my @columns = @{$sth->{NAME_lc}};
1869 for my $i ( 0 .. $#columns ){
1871 $column_info{data_type} = $sth->{TYPE}->[$i];
1872 $column_info{size} = $sth->{PRECISION}->[$i];
1873 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1875 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1876 $column_info{data_type} = $1;
1877 $column_info{size} = $2;
1880 $result{$columns[$i]} = \%column_info;
1884 foreach my $col (keys %result) {
1885 my $colinfo = $result{$col};
1886 my $type_num = $colinfo->{data_type};
1888 if(defined $type_num && $dbh->can('type_info')) {
1889 my $type_info = $dbh->type_info($type_num);
1890 $type_name = $type_info->{TYPE_NAME} if $type_info;
1891 $colinfo->{data_type} = $type_name if $type_name;
1898 sub columns_info_for {
1899 my ($self, $table) = @_;
1900 $self->dbh_do('_dbh_columns_info_for', $table);
1903 =head2 last_insert_id
1905 Return the row id of the last insert.
1909 sub _dbh_last_insert_id {
1910 # All Storage's need to register their own _dbh_last_insert_id
1911 # the old SQLite-based method was highly inappropriate
1914 my $class = ref $self;
1915 $self->throw_exception (<<EOE);
1917 No _dbh_last_insert_id() method found in $class.
1918 Since the method of obtaining the autoincrement id of the last insert
1919 operation varies greatly between different databases, this method must be
1920 individually implemented for every storage class.
1924 sub last_insert_id {
1926 $self->dbh_do('_dbh_last_insert_id', @_);
1931 Returns the database driver name.
1935 sub sqlt_type { shift->_get_dbh->{Driver}->{Name} }
1937 =head2 bind_attribute_by_data_type
1939 Given a datatype from column info, returns a database specific bind
1940 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1941 let the database planner just handle it.
1943 Generally only needed for special case column types, like bytea in postgres.
1947 sub bind_attribute_by_data_type {
1951 =head2 is_datatype_numeric
1953 Given a datatype from column_info, returns a boolean value indicating if
1954 the current RDBMS considers it a numeric value. This controls how
1955 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1956 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1957 be performed instead of the usual C<eq>.
1961 sub is_datatype_numeric {
1962 my ($self, $dt) = @_;
1964 return 0 unless $dt;
1966 return $dt =~ /^ (?:
1967 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
1972 =head2 create_ddl_dir (EXPERIMENTAL)
1976 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1980 Creates a SQL file based on the Schema, for each of the specified
1981 database engines in C<\@databases> in the given directory.
1982 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1984 Given a previous version number, this will also create a file containing
1985 the ALTER TABLE statements to transform the previous schema into the
1986 current one. Note that these statements may contain C<DROP TABLE> or
1987 C<DROP COLUMN> statements that can potentially destroy data.
1989 The file names are created using the C<ddl_filename> method below, please
1990 override this method in your schema if you would like a different file
1991 name format. For the ALTER file, the same format is used, replacing
1992 $version in the name with "$preversion-$version".
1994 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1995 The most common value for this would be C<< { add_drop_table => 1 } >>
1996 to have the SQL produced include a C<DROP TABLE> statement for each table
1997 created. For quoting purposes supply C<quote_table_names> and
1998 C<quote_field_names>.
2000 If no arguments are passed, then the following default values are assumed:
2004 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2006 =item version - $schema->schema_version
2008 =item directory - './'
2010 =item preversion - <none>
2014 By default, C<\%sqlt_args> will have
2016 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2018 merged with the hash passed in. To disable any of those features, pass in a
2019 hashref like the following
2021 { ignore_constraint_names => 0, # ... other options }
2024 Note that this feature is currently EXPERIMENTAL and may not work correctly
2025 across all databases, or fully handle complex relationships.
2027 WARNING: Please check all SQL files created, before applying them.
2031 sub create_ddl_dir {
2032 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2034 if(!$dir || !-d $dir) {
2035 carp "No directory given, using ./\n";
2038 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2039 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2041 my $schema_version = $schema->schema_version || '1.x';
2042 $version ||= $schema_version;
2045 add_drop_table => 1,
2046 ignore_constraint_names => 1,
2047 ignore_index_names => 1,
2051 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2052 . $self->_check_sqlt_message . q{'})
2053 if !$self->_check_sqlt_version;
2055 my $sqlt = SQL::Translator->new( $sqltargs );
2057 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2058 my $sqlt_schema = $sqlt->translate({ data => $schema })
2059 or $self->throw_exception ($sqlt->error);
2061 foreach my $db (@$databases) {
2063 $sqlt->{schema} = $sqlt_schema;
2064 $sqlt->producer($db);
2067 my $filename = $schema->ddl_filename($db, $version, $dir);
2068 if (-e $filename && ($version eq $schema_version )) {
2069 # if we are dumping the current version, overwrite the DDL
2070 carp "Overwriting existing DDL file - $filename";
2074 my $output = $sqlt->translate;
2076 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2079 if(!open($file, ">$filename")) {
2080 $self->throw_exception("Can't open $filename for writing ($!)");
2083 print $file $output;
2086 next unless ($preversion);
2088 require SQL::Translator::Diff;
2090 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2091 if(!-e $prefilename) {
2092 carp("No previous schema file found ($prefilename)");
2096 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2098 carp("Overwriting existing diff file - $difffile");
2104 my $t = SQL::Translator->new($sqltargs);
2109 or $self->throw_exception ($t->error);
2111 my $out = $t->translate( $prefilename )
2112 or $self->throw_exception ($t->error);
2114 $source_schema = $t->schema;
2116 $source_schema->name( $prefilename )
2117 unless ( $source_schema->name );
2120 # The "new" style of producers have sane normalization and can support
2121 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2122 # And we have to diff parsed SQL against parsed SQL.
2123 my $dest_schema = $sqlt_schema;
2125 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2126 my $t = SQL::Translator->new($sqltargs);
2131 or $self->throw_exception ($t->error);
2133 my $out = $t->translate( $filename )
2134 or $self->throw_exception ($t->error);
2136 $dest_schema = $t->schema;
2138 $dest_schema->name( $filename )
2139 unless $dest_schema->name;
2142 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2146 if(!open $file, ">$difffile") {
2147 $self->throw_exception("Can't write to $difffile ($!)");
2155 =head2 deployment_statements
2159 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2163 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2165 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2166 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2168 C<$directory> is used to return statements from files in a previously created
2169 L</create_ddl_dir> directory and is optional. The filenames are constructed
2170 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2172 If no C<$directory> is specified then the statements are constructed on the
2173 fly using L<SQL::Translator> and C<$version> is ignored.
2175 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2179 sub deployment_statements {
2180 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2181 # Need to be connected to get the correct sqlt_type
2182 $self->_get_dbh() unless $type;
2183 $type ||= $self->sqlt_type;
2184 $version ||= $schema->schema_version || '1.x';
2186 my $filename = $schema->ddl_filename($type, $version, $dir);
2190 open($file, "<$filename")
2191 or $self->throw_exception("Can't open $filename ($!)");
2194 return join('', @rows);
2197 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2198 . $self->_check_sqlt_message . q{'})
2199 if !$self->_check_sqlt_version;
2201 require SQL::Translator::Parser::DBIx::Class;
2202 eval qq{use SQL::Translator::Producer::${type}};
2203 $self->throw_exception($@) if $@;
2205 # sources needs to be a parser arg, but for simplicty allow at top level
2207 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2208 if exists $sqltargs->{sources};
2210 my $tr = SQL::Translator->new(%$sqltargs);
2211 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2212 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2216 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2219 return if($line =~ /^--/);
2221 # next if($line =~ /^DROP/m);
2222 return if($line =~ /^BEGIN TRANSACTION/m);
2223 return if($line =~ /^COMMIT/m);
2224 return if $line =~ /^\s+$/; # skip whitespace only
2225 $self->_query_start($line);
2227 $self->_get_dbh->do($line);
2230 carp qq{$@ (running "${line}")};
2232 $self->_query_end($line);
2234 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2235 if (@statements > 1) {
2236 foreach my $statement (@statements) {
2237 $deploy->( $statement );
2240 elsif (@statements == 1) {
2241 foreach my $line ( split(";\n", $statements[0])) {
2247 =head2 datetime_parser
2249 Returns the datetime parser class
2253 sub datetime_parser {
2255 return $self->{datetime_parser} ||= do {
2257 $self->build_datetime_parser(@_);
2261 =head2 datetime_parser_type
2263 Defines (returns) the datetime parser class - currently hardwired to
2264 L<DateTime::Format::MySQL>
2268 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2270 =head2 build_datetime_parser
2272 See L</datetime_parser>
2276 sub build_datetime_parser {
2278 my $type = $self->datetime_parser_type(@_);
2280 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2285 my $_check_sqlt_version; # private
2286 my $_check_sqlt_message; # private
2287 sub _check_sqlt_version {
2288 return $_check_sqlt_version if defined $_check_sqlt_version;
2289 eval 'use SQL::Translator "0.09003"';
2290 $_check_sqlt_message = $@ || '';
2291 $_check_sqlt_version = !$@;
2294 sub _check_sqlt_message {
2295 _check_sqlt_version if !defined $_check_sqlt_message;
2296 $_check_sqlt_message;
2300 =head2 is_replicating
2302 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2303 replicate from a master database. Default is undef, which is the result
2304 returned by databases that don't support replication.
2308 sub is_replicating {
2313 =head2 lag_behind_master
2315 Returns a number that represents a certain amount of lag behind a master db
2316 when a given storage is replicating. The number is database dependent, but
2317 starts at zero and increases with the amount of lag. Default in undef
2321 sub lag_behind_master {
2327 return if !$self->_dbh;
2336 =head2 DBIx::Class and AutoCommit
2338 DBIx::Class can do some wonderful magic with handling exceptions,
2339 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2340 combined with C<txn_do> for transaction support.
2342 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2343 in an assumed transaction between commits, and you're telling us you'd
2344 like to manage that manually. A lot of the magic protections offered by
2345 this module will go away. We can't protect you from exceptions due to database
2346 disconnects because we don't know anything about how to restart your
2347 transactions. You're on your own for handling all sorts of exceptional
2348 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2355 Matt S. Trout <mst@shadowcatsystems.co.uk>
2357 Andy Grundman <andy@hybridized.org>
2361 You may distribute this code under the same terms as Perl itself.