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 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
442 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
443 $self->_connect_info;
448 This method is deprecated in favour of setting via L</connect_info>.
452 =head2 on_disconnect_do
454 This method is deprecated in favour of setting via L</connect_info>.
458 sub _parse_connect_do {
459 my ($self, $type) = @_;
461 my $val = $self->$type;
462 return () if not defined $val;
467 push @res, [ 'do_sql', $val ];
468 } elsif (ref($val) eq 'CODE') {
470 } elsif (ref($val) eq 'ARRAY') {
471 push @res, map { [ 'do_sql', $_ ] } @$val;
473 $self->throw_exception("Invalid type for $type: ".ref($val));
481 Arguments: ($subref | $method_name), @extra_coderef_args?
483 Execute the given $subref or $method_name using the new exception-based
484 connection management.
486 The first two arguments will be the storage object that C<dbh_do> was called
487 on and a database handle to use. Any additional arguments will be passed
488 verbatim to the called subref as arguments 2 and onwards.
490 Using this (instead of $self->_dbh or $self->dbh) ensures correct
491 exception handling and reconnection (or failover in future subclasses).
493 Your subref should have no side-effects outside of the database, as
494 there is the potential for your subref to be partially double-executed
495 if the database connection was stale/dysfunctional.
499 my @stuff = $schema->storage->dbh_do(
501 my ($storage, $dbh, @cols) = @_;
502 my $cols = join(q{, }, @cols);
503 $dbh->selectrow_array("SELECT $cols FROM foo");
514 my $dbh = $self->_dbh;
516 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
517 || $self->{transaction_depth};
519 local $self->{_in_dbh_do} = 1;
522 my $want_array = wantarray;
525 $self->_verify_pid if $dbh;
527 $self->_populate_dbh;
532 @result = $self->$code($dbh, @_);
534 elsif(defined $want_array) {
535 $result[0] = $self->$code($dbh, @_);
538 $self->$code($dbh, @_);
543 if(!$exception) { return $want_array ? @result : $result[0] }
545 $self->throw_exception($exception) if $self->connected;
547 # We were not connected - reconnect and retry, but let any
548 # exception fall right through this time
549 $self->_populate_dbh;
550 $self->$code($self->_dbh, @_);
553 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
554 # It also informs dbh_do to bypass itself while under the direction of txn_do,
555 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
560 ref $coderef eq 'CODE' or $self->throw_exception
561 ('$coderef must be a CODE reference');
563 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
565 local $self->{_in_dbh_do} = 1;
568 my $want_array = wantarray;
573 $self->_verify_pid if $self->_dbh;
574 $self->_populate_dbh if !$self->_dbh;
578 @result = $coderef->(@_);
580 elsif(defined $want_array) {
581 $result[0] = $coderef->(@_);
590 if(!$exception) { return $want_array ? @result : $result[0] }
592 if($tried++ > 0 || $self->connected) {
593 eval { $self->txn_rollback };
594 my $rollback_exception = $@;
595 if($rollback_exception) {
596 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
597 $self->throw_exception($exception) # propagate nested rollback
598 if $rollback_exception =~ /$exception_class/;
600 $self->throw_exception(
601 "Transaction aborted: ${exception}. "
602 . "Rollback failed: ${rollback_exception}"
605 $self->throw_exception($exception)
608 # We were not connected, and was first try - reconnect and retry
610 $self->_populate_dbh;
616 Our C<disconnect> method also performs a rollback first if the
617 database is not in C<AutoCommit> mode.
624 if( $self->connected ) {
627 push @actions, ( $self->on_disconnect_call || () );
628 push @actions, $self->_parse_connect_do ('on_disconnect_do');
630 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
632 $self->_dbh_rollback unless $self->_dbh_autocommit;
634 $self->_dbh->disconnect;
640 =head2 with_deferred_fk_checks
644 =item Arguments: C<$coderef>
646 =item Return Value: The return value of $coderef
650 Storage specific method to run the code ref with FK checks deferred or
651 in MySQL's case disabled entirely.
655 # Storage subclasses should override this
656 sub with_deferred_fk_checks {
657 my ($self, $sub) = @_;
665 if(my $dbh = $self->_dbh) {
666 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
673 return 0 if !$self->_dbh;
675 return ($dbh->FETCH('Active') && $self->_ping);
684 my $dbh = $self->_dbh or return 0;
689 # handle pid changes correctly
690 # NOTE: assumes $self->_dbh is a valid $dbh
694 return if defined $self->_conn_pid && $self->_conn_pid == $$;
696 $self->_dbh->{InactiveDestroy} = 1;
703 sub ensure_connected {
706 unless ($self->connected) {
707 $self->_populate_dbh;
713 Returns the dbh - a data base handle of class L<DBI>.
720 $self->ensure_connected;
724 sub _sql_maker_args {
727 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
732 unless ($self->_sql_maker) {
733 my $sql_maker_class = $self->sql_maker_class;
734 $self->ensure_class_loaded ($sql_maker_class);
735 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
737 return $self->_sql_maker;
744 my @info = @{$self->_dbi_connect_info || []};
745 $self->_dbh($self->_connect(@info));
747 $self->_conn_pid($$);
748 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
750 $self->_determine_driver;
752 # Always set the transaction depth on connect, since
753 # there is no transaction in progress by definition
754 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
758 push @actions, ( $self->on_connect_call || () );
759 push @actions, $self->_parse_connect_do ('on_connect_do');
761 $self->_do_connection_actions(connect_call_ => $_) for @actions;
764 sub _determine_driver {
767 if (ref $self eq 'DBIx::Class::Storage::DBI') {
770 if ($self->_dbh) { # we are connected
771 $driver = $self->_dbh->{Driver}{Name};
773 # try to use dsn to not require being connected, the driver may still
774 # force a connection in _rebless to determine version
775 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
778 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
779 if ($self->load_optional_class($storage_class)) {
780 mro::set_mro($storage_class, 'c3');
781 bless $self, $storage_class;
787 sub _do_connection_actions {
789 my $method_prefix = shift;
792 if (not ref($call)) {
793 my $method = $method_prefix . $call;
795 } elsif (ref($call) eq 'CODE') {
797 } elsif (ref($call) eq 'ARRAY') {
798 if (ref($call->[0]) ne 'ARRAY') {
799 $self->_do_connection_actions($method_prefix, $_) for @$call;
801 $self->_do_connection_actions($method_prefix, @$_) for @$call;
804 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
810 sub connect_call_do_sql {
812 $self->_do_query(@_);
815 sub disconnect_call_do_sql {
817 $self->_do_query(@_);
820 # override in db-specific backend when necessary
821 sub connect_call_datetime_setup { 1 }
824 my ($self, $action) = @_;
826 if (ref $action eq 'CODE') {
827 $action = $action->($self);
828 $self->_do_query($_) foreach @$action;
831 # Most debuggers expect ($sql, @bind), so we need to exclude
832 # the attribute hash which is the second argument to $dbh->do
833 # furthermore the bind values are usually to be presented
834 # as named arrayref pairs, so wrap those here too
835 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
836 my $sql = shift @do_args;
837 my $attrs = shift @do_args;
838 my @bind = map { [ undef, $_ ] } @do_args;
840 $self->_query_start($sql, @bind);
841 $self->_dbh->do($sql, $attrs, @do_args);
842 $self->_query_end($sql, @bind);
849 my ($self, @info) = @_;
851 $self->throw_exception("You failed to provide any connection info")
854 my ($old_connect_via, $dbh);
856 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
857 $old_connect_via = $DBI::connect_via;
858 $DBI::connect_via = 'connect';
862 if(ref $info[0] eq 'CODE') {
866 $dbh = DBI->connect(@info);
869 if($dbh && !$self->unsafe) {
870 my $weak_self = $self;
871 Scalar::Util::weaken($weak_self);
872 $dbh->{HandleError} = sub {
874 $weak_self->throw_exception("DBI Exception: $_[0]");
877 croak ("DBI Exception: $_[0]");
880 $dbh->{ShowErrorStatement} = 1;
881 $dbh->{RaiseError} = 1;
882 $dbh->{PrintError} = 0;
886 $DBI::connect_via = $old_connect_via if $old_connect_via;
888 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
891 $self->_dbh_autocommit($dbh->{AutoCommit});
897 my ($self, $name) = @_;
899 $name = $self->_svp_generate_name
900 unless defined $name;
902 $self->throw_exception ("You can't use savepoints outside a transaction")
903 if $self->{transaction_depth} == 0;
905 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
906 unless $self->can('_svp_begin');
908 push @{ $self->{savepoints} }, $name;
910 $self->debugobj->svp_begin($name) if $self->debug;
912 return $self->_svp_begin($name);
916 my ($self, $name) = @_;
918 $self->throw_exception ("You can't use savepoints outside a transaction")
919 if $self->{transaction_depth} == 0;
921 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
922 unless $self->can('_svp_release');
925 $self->throw_exception ("Savepoint '$name' does not exist")
926 unless grep { $_ eq $name } @{ $self->{savepoints} };
928 # Dig through the stack until we find the one we are releasing. This keeps
929 # the stack up to date.
932 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
934 $name = pop @{ $self->{savepoints} };
937 $self->debugobj->svp_release($name) if $self->debug;
939 return $self->_svp_release($name);
943 my ($self, $name) = @_;
945 $self->throw_exception ("You can't use savepoints outside a transaction")
946 if $self->{transaction_depth} == 0;
948 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
949 unless $self->can('_svp_rollback');
952 # If they passed us a name, verify that it exists in the stack
953 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
954 $self->throw_exception("Savepoint '$name' does not exist!");
957 # Dig through the stack until we find the one we are releasing. This keeps
958 # the stack up to date.
959 while(my $s = pop(@{ $self->{savepoints} })) {
960 last if($s eq $name);
962 # Add the savepoint back to the stack, as a rollback doesn't remove the
963 # named savepoint, only everything after it.
964 push(@{ $self->{savepoints} }, $name);
966 # We'll assume they want to rollback to the last savepoint
967 $name = $self->{savepoints}->[-1];
970 $self->debugobj->svp_rollback($name) if $self->debug;
972 return $self->_svp_rollback($name);
975 sub _svp_generate_name {
978 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
983 $self->ensure_connected();
984 if($self->{transaction_depth} == 0) {
985 $self->debugobj->txn_begin()
987 # this isn't ->_dbh-> because
988 # we should reconnect on begin_work
989 # for AutoCommit users
990 $self->_dbh_begin_work;
991 } elsif ($self->auto_savepoint) {
994 $self->{transaction_depth}++;
997 sub _dbh_begin_work {
999 $self->dbh->begin_work;
1004 if ($self->{transaction_depth} == 1) {
1005 my $dbh = $self->_dbh;
1006 $self->debugobj->txn_commit()
1009 $self->{transaction_depth} = 0
1010 if $self->_dbh_autocommit;
1012 elsif($self->{transaction_depth} > 1) {
1013 $self->{transaction_depth}--;
1015 if $self->auto_savepoint;
1021 $self->_dbh->commit;
1026 my $dbh = $self->_dbh;
1028 if ($self->{transaction_depth} == 1) {
1029 $self->debugobj->txn_rollback()
1031 $self->{transaction_depth} = 0
1032 if $self->_dbh_autocommit;
1033 $self->_dbh_rollback;
1035 elsif($self->{transaction_depth} > 1) {
1036 $self->{transaction_depth}--;
1037 if ($self->auto_savepoint) {
1038 $self->svp_rollback;
1043 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1048 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1049 $error =~ /$exception_class/ and $self->throw_exception($error);
1050 # ensure that a failed rollback resets the transaction depth
1051 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1052 $self->throw_exception($error);
1058 $self->_dbh->rollback;
1061 # This used to be the top-half of _execute. It was split out to make it
1062 # easier to override in NoBindVars without duping the rest. It takes up
1063 # all of _execute's args, and emits $sql, @bind.
1064 sub _prep_for_execute {
1065 my ($self, $op, $extra_bind, $ident, $args) = @_;
1067 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1068 $ident = $ident->from();
1071 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1074 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1076 return ($sql, \@bind);
1080 sub _fix_bind_params {
1081 my ($self, @bind) = @_;
1083 ### Turn @bind from something like this:
1084 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1086 ### ( "'1'", "'1'", "'3'" )
1089 if ( defined( $_ && $_->[1] ) ) {
1090 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1097 my ( $self, $sql, @bind ) = @_;
1099 if ( $self->debug ) {
1100 @bind = $self->_fix_bind_params(@bind);
1102 $self->debugobj->query_start( $sql, @bind );
1107 my ( $self, $sql, @bind ) = @_;
1109 if ( $self->debug ) {
1110 @bind = $self->_fix_bind_params(@bind);
1111 $self->debugobj->query_end( $sql, @bind );
1116 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1118 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1120 $self->_query_start( $sql, @$bind );
1122 my $sth = $self->sth($sql,$op);
1124 my $placeholder_index = 1;
1126 foreach my $bound (@$bind) {
1127 my $attributes = {};
1128 my($column_name, @data) = @$bound;
1130 if ($bind_attributes) {
1131 $attributes = $bind_attributes->{$column_name}
1132 if defined $bind_attributes->{$column_name};
1135 foreach my $data (@data) {
1136 my $ref = ref $data;
1137 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1139 $sth->bind_param($placeholder_index, $data, $attributes);
1140 $placeholder_index++;
1144 # Can this fail without throwing an exception anyways???
1145 my $rv = $sth->execute();
1146 $self->throw_exception($sth->errstr) if !$rv;
1148 $self->_query_end( $sql, @$bind );
1150 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1155 $self->dbh_do('_dbh_execute', @_)
1159 my ($self, $source, $to_insert) = @_;
1161 my $ident = $source->from;
1162 my $bind_attributes = $self->source_bind_attributes($source);
1164 my $updated_cols = {};
1166 $self->ensure_connected;
1167 foreach my $col ( $source->columns ) {
1168 if ( !defined $to_insert->{$col} ) {
1169 my $col_info = $source->column_info($col);
1171 if ( $col_info->{auto_nextval} ) {
1172 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1177 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1179 return $updated_cols;
1182 ## Still not quite perfect, and EXPERIMENTAL
1183 ## Currently it is assumed that all values passed will be "normal", i.e. not
1184 ## scalar refs, or at least, all the same type as the first set, the statement is
1185 ## only prepped once.
1187 my ($self, $source, $cols, $data) = @_;
1189 my $table = $source->from;
1190 @colvalues{@$cols} = (0..$#$cols);
1191 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1193 $self->_query_start( $sql, @bind );
1194 my $sth = $self->sth($sql);
1196 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1198 ## This must be an arrayref, else nothing works!
1199 my $tuple_status = [];
1201 ## Get the bind_attributes, if any exist
1202 my $bind_attributes = $self->source_bind_attributes($source);
1204 ## Bind the values and execute
1205 my $placeholder_index = 1;
1207 foreach my $bound (@bind) {
1209 my $attributes = {};
1210 my ($column_name, $data_index) = @$bound;
1212 if( $bind_attributes ) {
1213 $attributes = $bind_attributes->{$column_name}
1214 if defined $bind_attributes->{$column_name};
1217 my @data = map { $_->[$data_index] } @$data;
1219 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1220 $placeholder_index++;
1222 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1225 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1227 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1228 if ($i > $#$tuple_status);
1230 require Data::Dumper;
1231 local $Data::Dumper::Terse = 1;
1232 local $Data::Dumper::Indent = 1;
1233 local $Data::Dumper::Useqq = 1;
1234 local $Data::Dumper::Quotekeys = 0;
1236 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1237 $tuple_status->[$i][1],
1238 Data::Dumper::Dumper(
1239 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1243 $self->throw_exception($sth->errstr) if !$rv;
1245 $self->_query_end( $sql, @bind );
1246 return (wantarray ? ($rv, $sth, @bind) : $rv);
1250 my $self = shift @_;
1251 my $source = shift @_;
1252 my $bind_attributes = $self->source_bind_attributes($source);
1254 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1259 my $self = shift @_;
1260 my $source = shift @_;
1262 my $bind_attrs = $self->source_bind_attributes($source);
1264 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1267 # We were sent here because the $rs contains a complex search
1268 # which will require a subquery to select the correct rows
1269 # (i.e. joined or limited resultsets)
1271 # Genarating a single PK column subquery is trivial and supported
1272 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1273 # Look at _multipk_update_delete()
1274 sub _subq_update_delete {
1276 my ($rs, $op, $values) = @_;
1278 my $rsrc = $rs->result_source;
1280 # we already check this, but double check naively just in case. Should be removed soon
1281 my $sel = $rs->_resolved_attrs->{select};
1282 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1283 my @pcols = $rsrc->primary_columns;
1284 if (@$sel != @pcols) {
1285 $self->throw_exception (
1286 'Subquery update/delete can not be called on resultsets selecting a'
1287 .' number of columns different than the number of primary keys'
1294 $op eq 'update' ? $values : (),
1295 { $pcols[0] => { -in => $rs->as_query } },
1300 return $self->_multipk_update_delete (@_);
1304 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1305 # resultset update/delete involving subqueries. So by default resort
1306 # to simple (and inefficient) delete_all style per-row opearations,
1307 # while allowing specific storages to override this with a faster
1310 sub _multipk_update_delete {
1311 return shift->_per_row_update_delete (@_);
1314 # This is the default loop used to delete/update rows for multi PK
1315 # resultsets, and used by mysql exclusively (because it can't do anything
1318 # We do not use $row->$op style queries, because resultset update/delete
1319 # is not expected to cascade (this is what delete_all/update_all is for).
1321 # There should be no race conditions as the entire operation is rolled
1324 sub _per_row_update_delete {
1326 my ($rs, $op, $values) = @_;
1328 my $rsrc = $rs->result_source;
1329 my @pcols = $rsrc->primary_columns;
1331 my $guard = $self->txn_scope_guard;
1333 # emulate the return value of $sth->execute for non-selects
1334 my $row_cnt = '0E0';
1336 my $subrs_cur = $rs->cursor;
1337 while (my @pks = $subrs_cur->next) {
1340 for my $i (0.. $#pcols) {
1341 $cond->{$pcols[$i]} = $pks[$i];
1346 $op eq 'update' ? $values : (),
1361 # localization is neccessary as
1362 # 1) there is no infrastructure to pass this around before SQLA2
1363 # 2) _select_args sets it and _prep_for_execute consumes it
1364 my $sql_maker = $self->sql_maker;
1365 local $sql_maker->{_dbic_rs_attrs};
1367 return $self->_execute($self->_select_args(@_));
1370 sub _select_args_to_query {
1373 # localization is neccessary as
1374 # 1) there is no infrastructure to pass this around before SQLA2
1375 # 2) _select_args sets it and _prep_for_execute consumes it
1376 my $sql_maker = $self->sql_maker;
1377 local $sql_maker->{_dbic_rs_attrs};
1379 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1380 # = $self->_select_args($ident, $select, $cond, $attrs);
1381 my ($op, $bind, $ident, $bind_attrs, @args) =
1382 $self->_select_args(@_);
1384 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1385 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1386 $prepared_bind ||= [];
1389 ? ($sql, $prepared_bind, $bind_attrs)
1390 : \[ "($sql)", @$prepared_bind ]
1395 my ($self, $ident, $select, $where, $attrs) = @_;
1397 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1399 my $sql_maker = $self->sql_maker;
1400 $sql_maker->{_dbic_rs_attrs} = {
1406 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1411 # calculate bind_attrs before possible $ident mangling
1412 my $bind_attrs = {};
1413 for my $alias (keys %$alias2source) {
1414 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1415 for my $col (keys %$bindtypes) {
1417 my $fqcn = join ('.', $alias, $col);
1418 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1420 # Unqialified column names are nice, but at the same time can be
1421 # rather ambiguous. What we do here is basically go along with
1422 # the loop, adding an unqualified column slot to $bind_attrs,
1423 # alongside the fully qualified name. As soon as we encounter
1424 # another column by that name (which would imply another table)
1425 # we unset the unqualified slot and never add any info to it
1426 # to avoid erroneous type binding. If this happens the users
1427 # only choice will be to fully qualify his column name
1429 if (exists $bind_attrs->{$col}) {
1430 $bind_attrs->{$col} = {};
1433 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1440 $attrs->{software_limit}
1442 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1444 $attrs->{software_limit} = 1;
1447 $self->throw_exception("rows attribute must be positive if present")
1448 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1450 # MySQL actually recommends this approach. I cringe.
1451 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1456 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1457 # otherwise delegate the limiting to the storage, unless software limit was requested
1459 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1461 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1462 $attrs->{prefetch_select} && @{$attrs->{prefetch_select}} )
1464 ($ident, $select, $where, $attrs)
1465 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1467 elsif (! $attrs->{software_limit} ) {
1468 push @limit, $attrs->{rows}, $attrs->{offset};
1472 # This would be the point to deflate anything found in $where
1473 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1474 # expect a row object. And all we have is a resultsource (it is trivial
1475 # to extract deflator coderefs via $alias2source above).
1477 # I don't see a way forward other than changing the way deflators are
1478 # invoked, and that's just bad...
1482 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1483 (qw/order_by group_by having/ )
1486 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1490 # This is the code producing joined subqueries like:
1491 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1493 sub _adjust_select_args_for_complex_prefetch {
1494 my ($self, $from, $select, $where, $attrs) = @_;
1496 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1497 if (ref $from ne 'ARRAY');
1499 # copies for mangling
1501 $select = [ @$select ];
1502 $attrs = { %$attrs };
1504 # separate attributes
1505 my $sub_attrs = { %$attrs };
1506 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1507 delete $sub_attrs->{$_} for qw/for collapse prefetch_select _collapse_order_by select as/;
1509 my $alias = $attrs->{alias};
1510 my $sql_maker = $self->sql_maker;
1512 # create subquery select list - consider only stuff *not* brought in by the prefetch
1513 my $sub_select = [];
1514 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{prefetch_select}} - 1) {
1515 my $sel = $attrs->{select}[$i];
1517 # alias any functions to the dbic-side 'as' label
1518 # adjust the outer select accordingly
1519 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1520 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1521 $select->[$i] = join ('.', $attrs->{alias}, ($attrs->{as}[$i] || "select_$i") );
1524 push @$sub_select, $sel;
1527 # bring over all non-collapse-induced order_by into the inner query (if any)
1528 # the outer one will have to keep them all
1529 delete $sub_attrs->{order_by};
1530 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1531 $sub_attrs->{order_by} = [
1532 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1537 my $join_root = shift @$from;
1538 my @outer_from = @$from;
1541 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1543 # in complex search_related chains $alias may *not* be 'me'
1544 # so always include it in the inner join, and also shift away
1545 # from the outer stack, so that the two datasets actually do
1547 if ($join_root->{-alias} ne $alias) {
1548 $inner_joins{$alias} = 1;
1550 while (@outer_from && $outer_from[0][0]{-alias} ne $alias) {
1553 if (! @outer_from) {
1554 $self->throw_exception ("Unable to find '$alias' in the {from} stack, something is wrong");
1557 shift @outer_from; # the new subquery will represent this alias, so get rid of it
1561 # decide which parts of the join will remain on the inside
1563 # this is not a very viable optimisation, but it was written
1564 # before I realised this, so might as well remain. We can throw
1565 # away _any_ branches of the join tree that are:
1566 # 1) not mentioned in the condition/order
1567 # 2) left-join leaves (or left-join leaf chains)
1568 # Most of the join conditions will not satisfy this, but for real
1569 # complex queries some might, and we might make some RDBMS happy.
1572 # since we do not have introspectable SQLA, we fall back to ugly
1573 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1574 # in order to determine what goes into %inner_joins
1575 # It may not be very efficient, but it's a reasonable stop-gap
1577 # produce stuff unquoted, so it can be scanned
1578 local $sql_maker->{quote_char};
1579 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1583 { ref $_ ? $_->[0] : $_ }
1584 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1587 my $where_sql = $sql_maker->where ($where);
1588 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1591 for my $alias (keys %join_info) {
1593 # any table alias found on a column name in where or order_by
1594 # gets included in %inner_joins
1595 # Also any parent joins that are needed to reach this particular alias
1596 for my $piece ($select_sql, $where_sql, @order_by ) {
1597 if ($piece =~ /\b $alias $sep/x) {
1598 $inner_joins{$alias} = 1;
1604 # scan for non-leaf/non-left joins and mark as needed
1605 # also mark all ancestor joins that are needed to reach this particular alias
1606 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1608 # traverse by the size of the -join_path i.e. reverse depth first
1609 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1611 my $j = $join_info{$alias};
1612 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1614 if ($inner_joins{$alias}) {
1615 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1619 # construct the inner $from for the subquery
1620 my $inner_from = [ $join_root ];
1621 for my $j (@$from) {
1622 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1625 # if a multi-type join was needed in the subquery ("multi" is indicated by
1626 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1627 for my $alias (keys %inner_joins) {
1629 # the dot comes from some weirdness in collapse
1630 # remove after the rewrite
1631 if ($attrs->{collapse}{".$alias"}) {
1632 $sub_attrs->{group_by} ||= $sub_select;
1637 # generate the subquery
1638 my $subq = $self->_select_args_to_query (
1645 # put it in the new {from}
1646 unshift @outer_from, {
1648 -source_handle => $join_root->{-source_handle},
1652 # This is totally horrific - the $where ends up in both the inner and outer query
1653 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1654 # then if where conditions apply to the *right* side of the prefetch, you may have
1655 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1656 # the outer select to exclude joins you didin't want in the first place
1658 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1659 return (\@outer_from, $select, $where, $attrs);
1662 sub _resolve_ident_sources {
1663 my ($self, $ident) = @_;
1665 my $alias2source = {};
1668 # the reason this is so contrived is that $ident may be a {from}
1669 # structure, specifying multiple tables to join
1670 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1671 # this is compat mode for insert/update/delete which do not deal with aliases
1672 $alias2source->{me} = $ident;
1675 elsif (ref $ident eq 'ARRAY') {
1679 if (ref $_ eq 'HASH') {
1681 $rs_alias = $tabinfo->{-alias};
1683 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1687 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1688 if ($tabinfo->{-source_handle});
1692 return ($alias2source, $rs_alias);
1695 # Takes $ident, \@column_names
1697 # returns { $column_name => \%column_info, ... }
1698 # also note: this adds -result_source => $rsrc to the column info
1701 # my $col_sources = $self->_resolve_column_info($ident, [map $_->[0], @{$bind}]);
1702 sub _resolve_column_info {
1703 my ($self, $ident, $colnames) = @_;
1704 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1706 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1709 my (%return, %converted);
1710 foreach my $col (@$colnames) {
1711 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1713 # deal with unqualified cols - we assume the main alias for all
1714 # unqualified ones, ugly but can't think of anything better right now
1715 $alias ||= $root_alias;
1717 my $rsrc = $alias2src->{$alias};
1718 $return{$col} = $rsrc && { %{$rsrc->column_info($colname)}, -result_source => $rsrc };
1723 # Returns a counting SELECT for a simple count
1724 # query. Abstracted so that a storage could override
1725 # this to { count => 'firstcol' } or whatever makes
1726 # sense as a performance optimization
1728 #my ($self, $source, $rs_attrs) = @_;
1729 return { count => '*' };
1732 # Returns a SELECT which will end up in the subselect
1733 # There may or may not be a group_by, as the subquery
1734 # might have been called to accomodate a limit
1736 # Most databases would be happy with whatever ends up
1737 # here, but some choke in various ways.
1739 sub _subq_count_select {
1740 my ($self, $source, $rs_attrs) = @_;
1741 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1743 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1744 return @pcols ? \@pcols : [ 1 ];
1748 sub source_bind_attributes {
1749 my ($self, $source) = @_;
1751 my $bind_attributes;
1752 foreach my $column ($source->columns) {
1754 my $data_type = $source->column_info($column)->{data_type} || '';
1755 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1759 return $bind_attributes;
1766 =item Arguments: $ident, $select, $condition, $attrs
1770 Handle a SQL select statement.
1776 my ($ident, $select, $condition, $attrs) = @_;
1777 return $self->cursor_class->new($self, \@_, $attrs);
1782 my ($rv, $sth, @bind) = $self->_select(@_);
1783 my @row = $sth->fetchrow_array;
1784 my @nextrow = $sth->fetchrow_array if @row;
1785 if(@row && @nextrow) {
1786 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1788 # Need to call finish() to work round broken DBDs
1797 =item Arguments: $sql
1801 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1806 my ($self, $dbh, $sql) = @_;
1808 # 3 is the if_active parameter which avoids active sth re-use
1809 my $sth = $self->disable_sth_caching
1810 ? $dbh->prepare($sql)
1811 : $dbh->prepare_cached($sql, {}, 3);
1813 # XXX You would think RaiseError would make this impossible,
1814 # but apparently that's not true :(
1815 $self->throw_exception($dbh->errstr) if !$sth;
1821 my ($self, $sql) = @_;
1822 $self->dbh_do('_dbh_sth', $sql);
1825 sub _dbh_columns_info_for {
1826 my ($self, $dbh, $table) = @_;
1828 if ($dbh->can('column_info')) {
1831 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1832 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1834 while ( my $info = $sth->fetchrow_hashref() ){
1836 $column_info{data_type} = $info->{TYPE_NAME};
1837 $column_info{size} = $info->{COLUMN_SIZE};
1838 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1839 $column_info{default_value} = $info->{COLUMN_DEF};
1840 my $col_name = $info->{COLUMN_NAME};
1841 $col_name =~ s/^\"(.*)\"$/$1/;
1843 $result{$col_name} = \%column_info;
1846 return \%result if !$@ && scalar keys %result;
1850 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1852 my @columns = @{$sth->{NAME_lc}};
1853 for my $i ( 0 .. $#columns ){
1855 $column_info{data_type} = $sth->{TYPE}->[$i];
1856 $column_info{size} = $sth->{PRECISION}->[$i];
1857 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1859 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1860 $column_info{data_type} = $1;
1861 $column_info{size} = $2;
1864 $result{$columns[$i]} = \%column_info;
1868 foreach my $col (keys %result) {
1869 my $colinfo = $result{$col};
1870 my $type_num = $colinfo->{data_type};
1872 if(defined $type_num && $dbh->can('type_info')) {
1873 my $type_info = $dbh->type_info($type_num);
1874 $type_name = $type_info->{TYPE_NAME} if $type_info;
1875 $colinfo->{data_type} = $type_name if $type_name;
1882 sub columns_info_for {
1883 my ($self, $table) = @_;
1884 $self->dbh_do('_dbh_columns_info_for', $table);
1887 =head2 last_insert_id
1889 Return the row id of the last insert.
1893 sub _dbh_last_insert_id {
1894 # All Storage's need to register their own _dbh_last_insert_id
1895 # the old SQLite-based method was highly inappropriate
1898 my $class = ref $self;
1899 $self->throw_exception (<<EOE);
1901 No _dbh_last_insert_id() method found in $class.
1902 Since the method of obtaining the autoincrement id of the last insert
1903 operation varies greatly between different databases, this method must be
1904 individually implemented for every storage class.
1908 sub last_insert_id {
1910 $self->dbh_do('_dbh_last_insert_id', @_);
1915 Returns the database driver name.
1919 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1921 =head2 bind_attribute_by_data_type
1923 Given a datatype from column info, returns a database specific bind
1924 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1925 let the database planner just handle it.
1927 Generally only needed for special case column types, like bytea in postgres.
1931 sub bind_attribute_by_data_type {
1935 =head2 is_datatype_numeric
1937 Given a datatype from column_info, returns a boolean value indicating if
1938 the current RDBMS considers it a numeric value. This controls how
1939 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1940 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1941 be performed instead of the usual C<eq>.
1945 sub is_datatype_numeric {
1946 my ($self, $dt) = @_;
1948 return 0 unless $dt;
1950 return $dt =~ /^ (?:
1951 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
1956 =head2 create_ddl_dir (EXPERIMENTAL)
1960 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1964 Creates a SQL file based on the Schema, for each of the specified
1965 database engines in C<\@databases> in the given directory.
1966 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1968 Given a previous version number, this will also create a file containing
1969 the ALTER TABLE statements to transform the previous schema into the
1970 current one. Note that these statements may contain C<DROP TABLE> or
1971 C<DROP COLUMN> statements that can potentially destroy data.
1973 The file names are created using the C<ddl_filename> method below, please
1974 override this method in your schema if you would like a different file
1975 name format. For the ALTER file, the same format is used, replacing
1976 $version in the name with "$preversion-$version".
1978 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1979 The most common value for this would be C<< { add_drop_table => 1 } >>
1980 to have the SQL produced include a C<DROP TABLE> statement for each table
1981 created. For quoting purposes supply C<quote_table_names> and
1982 C<quote_field_names>.
1984 If no arguments are passed, then the following default values are assumed:
1988 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1990 =item version - $schema->schema_version
1992 =item directory - './'
1994 =item preversion - <none>
1998 By default, C<\%sqlt_args> will have
2000 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2002 merged with the hash passed in. To disable any of those features, pass in a
2003 hashref like the following
2005 { ignore_constraint_names => 0, # ... other options }
2008 Note that this feature is currently EXPERIMENTAL and may not work correctly
2009 across all databases, or fully handle complex relationships.
2011 WARNING: Please check all SQL files created, before applying them.
2015 sub create_ddl_dir {
2016 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2018 if(!$dir || !-d $dir) {
2019 carp "No directory given, using ./\n";
2022 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2023 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2025 my $schema_version = $schema->schema_version || '1.x';
2026 $version ||= $schema_version;
2029 add_drop_table => 1,
2030 ignore_constraint_names => 1,
2031 ignore_index_names => 1,
2035 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2036 . $self->_check_sqlt_message . q{'})
2037 if !$self->_check_sqlt_version;
2039 my $sqlt = SQL::Translator->new( $sqltargs );
2041 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2042 my $sqlt_schema = $sqlt->translate({ data => $schema })
2043 or $self->throw_exception ($sqlt->error);
2045 foreach my $db (@$databases) {
2047 $sqlt->{schema} = $sqlt_schema;
2048 $sqlt->producer($db);
2051 my $filename = $schema->ddl_filename($db, $version, $dir);
2052 if (-e $filename && ($version eq $schema_version )) {
2053 # if we are dumping the current version, overwrite the DDL
2054 carp "Overwriting existing DDL file - $filename";
2058 my $output = $sqlt->translate;
2060 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2063 if(!open($file, ">$filename")) {
2064 $self->throw_exception("Can't open $filename for writing ($!)");
2067 print $file $output;
2070 next unless ($preversion);
2072 require SQL::Translator::Diff;
2074 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2075 if(!-e $prefilename) {
2076 carp("No previous schema file found ($prefilename)");
2080 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2082 carp("Overwriting existing diff file - $difffile");
2088 my $t = SQL::Translator->new($sqltargs);
2093 or $self->throw_exception ($t->error);
2095 my $out = $t->translate( $prefilename )
2096 or $self->throw_exception ($t->error);
2098 $source_schema = $t->schema;
2100 $source_schema->name( $prefilename )
2101 unless ( $source_schema->name );
2104 # The "new" style of producers have sane normalization and can support
2105 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2106 # And we have to diff parsed SQL against parsed SQL.
2107 my $dest_schema = $sqlt_schema;
2109 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2110 my $t = SQL::Translator->new($sqltargs);
2115 or $self->throw_exception ($t->error);
2117 my $out = $t->translate( $filename )
2118 or $self->throw_exception ($t->error);
2120 $dest_schema = $t->schema;
2122 $dest_schema->name( $filename )
2123 unless $dest_schema->name;
2126 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2130 if(!open $file, ">$difffile") {
2131 $self->throw_exception("Can't write to $difffile ($!)");
2139 =head2 deployment_statements
2143 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2147 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2149 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2150 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2152 C<$directory> is used to return statements from files in a previously created
2153 L</create_ddl_dir> directory and is optional. The filenames are constructed
2154 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2156 If no C<$directory> is specified then the statements are constructed on the
2157 fly using L<SQL::Translator> and C<$version> is ignored.
2159 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2163 sub deployment_statements {
2164 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2165 # Need to be connected to get the correct sqlt_type
2166 $self->ensure_connected() unless $type;
2167 $type ||= $self->sqlt_type;
2168 $version ||= $schema->schema_version || '1.x';
2170 my $filename = $schema->ddl_filename($type, $version, $dir);
2174 open($file, "<$filename")
2175 or $self->throw_exception("Can't open $filename ($!)");
2178 return join('', @rows);
2181 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2182 . $self->_check_sqlt_message . q{'})
2183 if !$self->_check_sqlt_version;
2185 require SQL::Translator::Parser::DBIx::Class;
2186 eval qq{use SQL::Translator::Producer::${type}};
2187 $self->throw_exception($@) if $@;
2189 # sources needs to be a parser arg, but for simplicty allow at top level
2191 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2192 if exists $sqltargs->{sources};
2194 my $tr = SQL::Translator->new(%$sqltargs);
2195 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2196 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2200 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2203 return if($line =~ /^--/);
2205 # next if($line =~ /^DROP/m);
2206 return if($line =~ /^BEGIN TRANSACTION/m);
2207 return if($line =~ /^COMMIT/m);
2208 return if $line =~ /^\s+$/; # skip whitespace only
2209 $self->_query_start($line);
2211 $self->dbh->do($line); # shouldn't be using ->dbh ?
2214 carp qq{$@ (running "${line}")};
2216 $self->_query_end($line);
2218 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2219 if (@statements > 1) {
2220 foreach my $statement (@statements) {
2221 $deploy->( $statement );
2224 elsif (@statements == 1) {
2225 foreach my $line ( split(";\n", $statements[0])) {
2231 =head2 datetime_parser
2233 Returns the datetime parser class
2237 sub datetime_parser {
2239 return $self->{datetime_parser} ||= do {
2240 $self->ensure_connected;
2241 $self->build_datetime_parser(@_);
2245 =head2 datetime_parser_type
2247 Defines (returns) the datetime parser class - currently hardwired to
2248 L<DateTime::Format::MySQL>
2252 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2254 =head2 build_datetime_parser
2256 See L</datetime_parser>
2260 sub build_datetime_parser {
2262 my $type = $self->datetime_parser_type(@_);
2264 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2269 my $_check_sqlt_version; # private
2270 my $_check_sqlt_message; # private
2271 sub _check_sqlt_version {
2272 return $_check_sqlt_version if defined $_check_sqlt_version;
2273 eval 'use SQL::Translator "0.09003"';
2274 $_check_sqlt_message = $@ || '';
2275 $_check_sqlt_version = !$@;
2278 sub _check_sqlt_message {
2279 _check_sqlt_version if !defined $_check_sqlt_message;
2280 $_check_sqlt_message;
2284 =head2 is_replicating
2286 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2287 replicate from a master database. Default is undef, which is the result
2288 returned by databases that don't support replication.
2292 sub is_replicating {
2297 =head2 lag_behind_master
2299 Returns a number that represents a certain amount of lag behind a master db
2300 when a given storage is replicating. The number is database dependent, but
2301 starts at zero and increases with the amount of lag. Default in undef
2305 sub lag_behind_master {
2309 =head2 order_columns_for_select
2311 Returns an ordered list of column names for use with a C<SELECT> when the column
2312 list is not explicitly specified.
2313 By default returns the result of L<DBIx::Class::ResultSource/columns>.
2315 This may be overridden in a specific storage when there are requirements such
2316 as moving C<BLOB> columns to the end of the list.
2320 sub order_columns_for_select {
2321 my ($self, $source, $columns) = @_;
2328 return if !$self->_dbh;
2337 =head2 DBIx::Class and AutoCommit
2339 DBIx::Class can do some wonderful magic with handling exceptions,
2340 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2341 combined with C<txn_do> for transaction support.
2343 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2344 in an assumed transaction between commits, and you're telling us you'd
2345 like to manage that manually. A lot of the magic protections offered by
2346 this module will go away. We can't protect you from exceptions due to database
2347 disconnects because we don't know anything about how to restart your
2348 transactions. You're on your own for handling all sorts of exceptional
2349 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2356 Matt S. Trout <mst@shadowcatsystems.co.uk>
2358 Andy Grundman <andy@hybridized.org>
2362 You may distribute this code under the same terms as Perl itself.