1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
7 use base 'DBIx::Class::Storage';
10 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use DBIx::Class::Storage::Statistics;
17 __PACKAGE__->mk_group_accessors('simple' =>
18 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
19 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints/
22 # the values for these accessors are picked out (and deleted) from
23 # the attribute hashref passed to connect_info
24 my @storage_options = qw/
25 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
26 disable_sth_caching unsafe auto_savepoint
28 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
31 # default cursor class, overridable in connect_info attributes
32 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
34 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
35 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
40 DBIx::Class::Storage::DBI - DBI storage handler
44 my $schema = MySchema->connect('dbi:SQLite:my.db');
46 $schema->storage->debug(1);
47 $schema->dbh_do("DROP TABLE authors");
49 $schema->resultset('Book')->search({
50 written_on => $schema->storage->datetime_parser(DateTime->now)
55 This class represents the connection to an RDBMS via L<DBI>. See
56 L<DBIx::Class::Storage> for general information. This pod only
57 documents DBI-specific methods and behaviors.
64 my $new = shift->next::method(@_);
66 $new->transaction_depth(0);
67 $new->_sql_maker_opts({});
68 $new->{savepoints} = [];
69 $new->{_in_dbh_do} = 0;
77 This method is normally called by L<DBIx::Class::Schema/connection>, which
78 encapsulates its argument list in an arrayref before passing them here.
80 The argument list may contain:
86 The same 4-element argument set one would normally pass to
87 L<DBI/connect>, optionally followed by
88 L<extra attributes|/DBIx::Class specific connection attributes>
89 recognized by DBIx::Class:
91 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
95 A single code reference which returns a connected
96 L<DBI database handle|DBI/connect> optionally followed by
97 L<extra attributes|/DBIx::Class specific connection attributes> recognized
100 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
104 A single hashref with all the attributes and the dsn/user/password
107 $connect_info_args = [{
115 This is particularly useful for L<Catalyst> based applications, allowing the
116 following config (L<Config::General> style):
121 dsn dbi:mysql:database=test
130 Please note that the L<DBI> docs recommend that you always explicitly
131 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
132 recommends that it be set to I<1>, and that you perform transactions
133 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
134 to I<1> if you do not do explicitly set it to zero. This is the default
135 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
137 =head3 DBIx::Class specific connection attributes
139 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
140 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
141 the following connection options. These options can be mixed in with your other
142 L<DBI> connection attributes, or placed in a seperate hashref
143 (C<\%extra_attributes>) as shown above.
145 Every time C<connect_info> is invoked, any previous settings for
146 these options will be cleared before setting the new ones, regardless of
147 whether any options are specified in the new C<connect_info>.
154 Specifies things to do immediately after connecting or re-connecting to
155 the database. Its value may contain:
161 This contains one SQL statement to execute.
163 =item an array reference
165 This contains SQL statements to execute in order. Each element contains
166 a string or a code reference that returns a string.
168 =item a code reference
170 This contains some code to execute. Unlike code references within an
171 array reference, its return value is ignored.
175 =item on_disconnect_do
177 Takes arguments in the same form as L</on_connect_do> and executes them
178 immediately before disconnecting from the database.
180 Note, this only runs if you explicitly call L</disconnect> on the
183 =item on_connect_call
185 A more generalized form of L</on_connect_do> that calls the specified
186 C<connect_call_METHOD> methods in your storage driver.
188 on_connect_do => 'select 1'
192 on_connect_call => [ [ do_sql => 'select 1' ] ]
194 Its values may contain:
200 Will call the C<connect_call_METHOD> method.
202 =item a code reference
204 Will execute C<< $code->($storage) >>
206 =item an array reference
208 Each value can be a method name or code reference.
210 =item an array of arrays
212 For each array, the first item is taken to be the C<connect_call_> method name
213 or code reference, and the rest are parameters to it.
217 Some predefined storage methods you may use:
223 Executes a SQL string or a code reference that returns a SQL string. This is
224 what L</on_connect_do> and L</on_disconnect_do> use.
232 Will execute the scalar as SQL.
236 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
237 attributes hashref and bind values.
239 =item a code reference
241 Will execute C<< $code->($storage) >> and execute the return array refs as
248 Execute any statements necessary to initialize the database session to return
249 and accept datetime/timestamp values used with
250 L<DBIx::Class::InflateColumn::DateTime>.
252 Only necessary for some databases, see your specific storage driver for
253 implementation details.
257 =item on_disconnect_call
259 Takes arguments in the same form as L</on_connect_call> and executes them
260 immediately before disconnecting from the database.
262 Calls the C<disconnect_call_METHOD> methods as opposed to the
263 C<connect_call_METHOD> methods called by L</on_connect_call>.
265 Note, this only runs if you explicitly call L</disconnect> on the
268 =item disable_sth_caching
270 If set to a true value, this option will disable the caching of
271 statement handles via L<DBI/prepare_cached>.
275 Sets the limit dialect. This is useful for JDBC-bridge among others
276 where the remote SQL-dialect cannot be determined by the name of the
277 driver alone. See also L<SQL::Abstract::Limit>.
281 Specifies what characters to use to quote table and column names. If
282 you use this you will want to specify L</name_sep> as well.
284 C<quote_char> expects either a single character, in which case is it
285 is placed on either side of the table/column name, or an arrayref of length
286 2 in which case the table/column name is placed between the elements.
288 For example under MySQL you should use C<< quote_char => '`' >>, and for
289 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
293 This only needs to be used in conjunction with C<quote_char>, and is used to
294 specify the charecter that seperates elements (schemas, tables, columns) from
295 each other. In most cases this is simply a C<.>.
297 The consequences of not supplying this value is that L<SQL::Abstract>
298 will assume DBIx::Class' uses of aliases to be complete column
299 names. The output will look like I<"me.name"> when it should actually
304 This Storage driver normally installs its own C<HandleError>, sets
305 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
306 all database handles, including those supplied by a coderef. It does this
307 so that it can have consistent and useful error behavior.
309 If you set this option to a true value, Storage will not do its usual
310 modifications to the database handle's attributes, and instead relies on
311 the settings in your connect_info DBI options (or the values you set in
312 your connection coderef, in the case that you are connecting via coderef).
314 Note that your custom settings can cause Storage to malfunction,
315 especially if you set a C<HandleError> handler that suppresses exceptions
316 and/or disable C<RaiseError>.
320 If this option is true, L<DBIx::Class> will use savepoints when nesting
321 transactions, making it possible to recover from failure in the inner
322 transaction without having to abort all outer transactions.
326 Use this argument to supply a cursor class other than the default
327 L<DBIx::Class::Storage::DBI::Cursor>.
331 Some real-life examples of arguments to L</connect_info> and
332 L<DBIx::Class::Schema/connect>
334 # Simple SQLite connection
335 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
338 ->connect_info([ sub { DBI->connect(...) } ]);
340 # A bit more complicated
347 { quote_char => q{"}, name_sep => q{.} },
351 # Equivalent to the previous example
357 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
361 # Same, but with hashref as argument
362 # See parse_connect_info for explanation
365 dsn => 'dbi:Pg:dbname=foo',
367 password => 'my_pg_password',
374 # Subref + DBIx::Class-specific connection options
377 sub { DBI->connect(...) },
381 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
382 disable_sth_caching => 1,
392 my ($self, $info_arg) = @_;
394 return $self->_connect_info if !$info_arg;
396 my @args = @$info_arg; # take a shallow copy for further mutilation
397 $self->_connect_info([@args]); # copy for _connect_info
400 # combine/pre-parse arguments depending on invocation style
403 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
404 %attrs = %{ $args[1] || {} };
407 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
408 %attrs = %{$args[0]};
410 for (qw/password user dsn/) {
411 unshift @args, delete $attrs{$_};
414 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
416 % { $args[3] || {} },
417 % { $args[4] || {} },
419 @args = @args[0,1,2];
422 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
423 # the new set of options
424 $self->_sql_maker(undef);
425 $self->_sql_maker_opts({});
428 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
429 if(my $value = delete $attrs{$storage_opt}) {
430 $self->$storage_opt($value);
433 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
434 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
435 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
440 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
442 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
443 $self->_connect_info;
448 This method is deprecated in favour of setting via L</connect_info>.
452 =head2 on_disconnect_do
454 This method is deprecated in favour of setting via L</connect_info>.
458 sub _parse_connect_do {
459 my ($self, $type) = @_;
461 my $val = $self->$type;
462 return () if not defined $val;
467 push @res, [ 'do_sql', $val ];
468 } elsif (ref($val) eq 'CODE') {
470 } elsif (ref($val) eq 'ARRAY') {
471 push @res, map { [ 'do_sql', $_ ] } @$val;
473 $self->throw_exception("Invalid type for $type: ".ref($val));
481 Arguments: ($subref | $method_name), @extra_coderef_args?
483 Execute the given $subref or $method_name using the new exception-based
484 connection management.
486 The first two arguments will be the storage object that C<dbh_do> was called
487 on and a database handle to use. Any additional arguments will be passed
488 verbatim to the called subref as arguments 2 and onwards.
490 Using this (instead of $self->_dbh or $self->dbh) ensures correct
491 exception handling and reconnection (or failover in future subclasses).
493 Your subref should have no side-effects outside of the database, as
494 there is the potential for your subref to be partially double-executed
495 if the database connection was stale/dysfunctional.
499 my @stuff = $schema->storage->dbh_do(
501 my ($storage, $dbh, @cols) = @_;
502 my $cols = join(q{, }, @cols);
503 $dbh->selectrow_array("SELECT $cols FROM foo");
514 my $dbh = $self->_dbh;
516 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
517 || $self->{transaction_depth};
519 local $self->{_in_dbh_do} = 1;
522 my $want_array = wantarray;
525 $self->_verify_pid if $dbh;
527 $self->_populate_dbh;
532 @result = $self->$code($dbh, @_);
534 elsif(defined $want_array) {
535 $result[0] = $self->$code($dbh, @_);
538 $self->$code($dbh, @_);
543 if(!$exception) { return $want_array ? @result : $result[0] }
545 $self->throw_exception($exception) if $self->connected;
547 # We were not connected - reconnect and retry, but let any
548 # exception fall right through this time
549 $self->_populate_dbh;
550 $self->$code($self->_dbh, @_);
553 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
554 # It also informs dbh_do to bypass itself while under the direction of txn_do,
555 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
560 ref $coderef eq 'CODE' or $self->throw_exception
561 ('$coderef must be a CODE reference');
563 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
565 local $self->{_in_dbh_do} = 1;
568 my $want_array = wantarray;
573 $self->_verify_pid if $self->_dbh;
574 $self->_populate_dbh if !$self->_dbh;
578 @result = $coderef->(@_);
580 elsif(defined $want_array) {
581 $result[0] = $coderef->(@_);
590 if(!$exception) { return $want_array ? @result : $result[0] }
592 if($tried++ > 0 || $self->connected) {
593 eval { $self->txn_rollback };
594 my $rollback_exception = $@;
595 if($rollback_exception) {
596 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
597 $self->throw_exception($exception) # propagate nested rollback
598 if $rollback_exception =~ /$exception_class/;
600 $self->throw_exception(
601 "Transaction aborted: ${exception}. "
602 . "Rollback failed: ${rollback_exception}"
605 $self->throw_exception($exception)
608 # We were not connected, and was first try - reconnect and retry
610 $self->_populate_dbh;
616 Our C<disconnect> method also performs a rollback first if the
617 database is not in C<AutoCommit> mode.
624 if( $self->connected ) {
627 push @actions, ( $self->on_disconnect_call || () );
628 push @actions, $self->_parse_connect_do ('on_disconnect_do');
630 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
632 $self->_dbh->rollback unless $self->_dbh_autocommit;
633 $self->_dbh->disconnect;
639 =head2 with_deferred_fk_checks
643 =item Arguments: C<$coderef>
645 =item Return Value: The return value of $coderef
649 Storage specific method to run the code ref with FK checks deferred or
650 in MySQL's case disabled entirely.
654 # Storage subclasses should override this
655 sub with_deferred_fk_checks {
656 my ($self, $sub) = @_;
664 if(my $dbh = $self->_dbh) {
665 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
672 return 0 if !$self->_dbh;
674 return ($dbh->FETCH('Active') && $self->_ping);
683 my $dbh = $self->_dbh or return 0;
688 # handle pid changes correctly
689 # NOTE: assumes $self->_dbh is a valid $dbh
693 return if defined $self->_conn_pid && $self->_conn_pid == $$;
695 $self->_dbh->{InactiveDestroy} = 1;
702 sub ensure_connected {
705 unless ($self->connected) {
706 $self->_populate_dbh;
712 Returns the dbh - a data base handle of class L<DBI>.
719 $self->ensure_connected;
723 sub _sql_maker_args {
726 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
731 unless ($self->_sql_maker) {
732 my $sql_maker_class = $self->sql_maker_class;
733 $self->ensure_class_loaded ($sql_maker_class);
734 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
736 return $self->_sql_maker;
743 my @info = @{$self->_dbi_connect_info || []};
744 $self->_dbh($self->_connect(@info));
746 $self->_conn_pid($$);
747 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
749 $self->_determine_driver;
751 # Always set the transaction depth on connect, since
752 # there is no transaction in progress by definition
753 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
757 push @actions, ( $self->on_connect_call || () );
758 push @actions, $self->_parse_connect_do ('on_connect_do');
760 $self->_do_connection_actions(connect_call_ => $_) for @actions;
763 sub _determine_driver {
766 if (not $self->_driver_determined) {
769 if ($self->_dbh) { # we are connected
770 $driver = $self->_dbh->{Driver}{Name};
772 # try to use dsn to not require being connected, the driver may still
773 # force a connection in _rebless to determine version
774 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
777 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
778 if ($self->load_optional_class($storage_class)) {
779 mro::set_mro($storage_class, 'c3');
780 bless $self, $storage_class;
784 $self->_driver_determined(1);
788 sub _do_connection_actions {
790 my $method_prefix = shift;
793 if (not ref($call)) {
794 my $method = $method_prefix . $call;
796 } elsif (ref($call) eq 'CODE') {
798 } elsif (ref($call) eq 'ARRAY') {
799 if (ref($call->[0]) ne 'ARRAY') {
800 $self->_do_connection_actions($method_prefix, $_) for @$call;
802 $self->_do_connection_actions($method_prefix, @$_) for @$call;
805 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
811 sub connect_call_do_sql {
813 $self->_do_query(@_);
816 sub disconnect_call_do_sql {
818 $self->_do_query(@_);
821 # override in db-specific backend when necessary
822 sub connect_call_datetime_setup { 1 }
825 my ($self, $action) = @_;
827 if (ref $action eq 'CODE') {
828 $action = $action->($self);
829 $self->_do_query($_) foreach @$action;
832 # Most debuggers expect ($sql, @bind), so we need to exclude
833 # the attribute hash which is the second argument to $dbh->do
834 # furthermore the bind values are usually to be presented
835 # as named arrayref pairs, so wrap those here too
836 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
837 my $sql = shift @do_args;
838 my $attrs = shift @do_args;
839 my @bind = map { [ undef, $_ ] } @do_args;
841 $self->_query_start($sql, @bind);
842 $self->_dbh->do($sql, $attrs, @do_args);
843 $self->_query_end($sql, @bind);
850 my ($self, @info) = @_;
852 $self->throw_exception("You failed to provide any connection info")
855 my ($old_connect_via, $dbh);
857 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
858 $old_connect_via = $DBI::connect_via;
859 $DBI::connect_via = 'connect';
863 if(ref $info[0] eq 'CODE') {
867 $dbh = DBI->connect(@info);
870 if($dbh && !$self->unsafe) {
871 my $weak_self = $self;
872 Scalar::Util::weaken($weak_self);
873 $dbh->{HandleError} = sub {
875 $weak_self->throw_exception("DBI Exception: $_[0]");
878 croak ("DBI Exception: $_[0]");
881 $dbh->{ShowErrorStatement} = 1;
882 $dbh->{RaiseError} = 1;
883 $dbh->{PrintError} = 0;
887 $DBI::connect_via = $old_connect_via if $old_connect_via;
889 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
892 $self->_dbh_autocommit($dbh->{AutoCommit});
898 my ($self, $name) = @_;
900 $name = $self->_svp_generate_name
901 unless defined $name;
903 $self->throw_exception ("You can't use savepoints outside a transaction")
904 if $self->{transaction_depth} == 0;
906 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
907 unless $self->can('_svp_begin');
909 push @{ $self->{savepoints} }, $name;
911 $self->debugobj->svp_begin($name) if $self->debug;
913 return $self->_svp_begin($name);
917 my ($self, $name) = @_;
919 $self->throw_exception ("You can't use savepoints outside a transaction")
920 if $self->{transaction_depth} == 0;
922 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
923 unless $self->can('_svp_release');
926 $self->throw_exception ("Savepoint '$name' does not exist")
927 unless grep { $_ eq $name } @{ $self->{savepoints} };
929 # Dig through the stack until we find the one we are releasing. This keeps
930 # the stack up to date.
933 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
935 $name = pop @{ $self->{savepoints} };
938 $self->debugobj->svp_release($name) if $self->debug;
940 return $self->_svp_release($name);
944 my ($self, $name) = @_;
946 $self->throw_exception ("You can't use savepoints outside a transaction")
947 if $self->{transaction_depth} == 0;
949 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
950 unless $self->can('_svp_rollback');
953 # If they passed us a name, verify that it exists in the stack
954 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
955 $self->throw_exception("Savepoint '$name' does not exist!");
958 # Dig through the stack until we find the one we are releasing. This keeps
959 # the stack up to date.
960 while(my $s = pop(@{ $self->{savepoints} })) {
961 last if($s eq $name);
963 # Add the savepoint back to the stack, as a rollback doesn't remove the
964 # named savepoint, only everything after it.
965 push(@{ $self->{savepoints} }, $name);
967 # We'll assume they want to rollback to the last savepoint
968 $name = $self->{savepoints}->[-1];
971 $self->debugobj->svp_rollback($name) if $self->debug;
973 return $self->_svp_rollback($name);
976 sub _svp_generate_name {
979 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
984 $self->ensure_connected();
985 if($self->{transaction_depth} == 0) {
986 $self->debugobj->txn_begin()
988 # this isn't ->_dbh-> because
989 # we should reconnect on begin_work
990 # for AutoCommit users
991 $self->dbh->begin_work;
992 } elsif ($self->auto_savepoint) {
995 $self->{transaction_depth}++;
1000 if ($self->{transaction_depth} == 1) {
1001 my $dbh = $self->_dbh;
1002 $self->debugobj->txn_commit()
1005 $self->{transaction_depth} = 0
1006 if $self->_dbh_autocommit;
1008 elsif($self->{transaction_depth} > 1) {
1009 $self->{transaction_depth}--;
1011 if $self->auto_savepoint;
1017 my $dbh = $self->_dbh;
1019 if ($self->{transaction_depth} == 1) {
1020 $self->debugobj->txn_rollback()
1022 $self->{transaction_depth} = 0
1023 if $self->_dbh_autocommit;
1026 elsif($self->{transaction_depth} > 1) {
1027 $self->{transaction_depth}--;
1028 if ($self->auto_savepoint) {
1029 $self->svp_rollback;
1034 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1039 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1040 $error =~ /$exception_class/ and $self->throw_exception($error);
1041 # ensure that a failed rollback resets the transaction depth
1042 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1043 $self->throw_exception($error);
1047 # This used to be the top-half of _execute. It was split out to make it
1048 # easier to override in NoBindVars without duping the rest. It takes up
1049 # all of _execute's args, and emits $sql, @bind.
1050 sub _prep_for_execute {
1051 my ($self, $op, $extra_bind, $ident, $args) = @_;
1053 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1054 $ident = $ident->from();
1057 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1060 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1062 return ($sql, \@bind);
1066 sub _fix_bind_params {
1067 my ($self, @bind) = @_;
1069 ### Turn @bind from something like this:
1070 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1072 ### ( "'1'", "'1'", "'3'" )
1075 if ( defined( $_ && $_->[1] ) ) {
1076 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1083 my ( $self, $sql, @bind ) = @_;
1085 if ( $self->debug ) {
1086 @bind = $self->_fix_bind_params(@bind);
1088 $self->debugobj->query_start( $sql, @bind );
1093 my ( $self, $sql, @bind ) = @_;
1095 if ( $self->debug ) {
1096 @bind = $self->_fix_bind_params(@bind);
1097 $self->debugobj->query_end( $sql, @bind );
1102 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1104 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1106 $self->_query_start( $sql, @$bind );
1108 my $sth = $self->sth($sql,$op);
1110 my $placeholder_index = 1;
1112 foreach my $bound (@$bind) {
1113 my $attributes = {};
1114 my($column_name, @data) = @$bound;
1116 if ($bind_attributes) {
1117 $attributes = $bind_attributes->{$column_name}
1118 if defined $bind_attributes->{$column_name};
1121 foreach my $data (@data) {
1122 my $ref = ref $data;
1123 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1125 $sth->bind_param($placeholder_index, $data, $attributes);
1126 $placeholder_index++;
1130 # Can this fail without throwing an exception anyways???
1131 my $rv = $sth->execute();
1132 $self->throw_exception($sth->errstr) if !$rv;
1134 $self->_query_end( $sql, @$bind );
1136 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1141 $self->dbh_do('_dbh_execute', @_)
1145 my ($self, $source, $to_insert) = @_;
1147 if (not $self->_driver_determined) {
1148 $self->_determine_driver;
1149 goto $self->can('insert');
1152 my $ident = $source->from;
1153 my $bind_attributes = $self->source_bind_attributes($source);
1155 my $updated_cols = {};
1157 foreach my $col ( $source->columns ) {
1158 if ( !defined $to_insert->{$col} ) {
1159 my $col_info = $source->column_info($col);
1161 if ( $col_info->{auto_nextval} ) {
1162 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1167 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1169 return $updated_cols;
1172 ## Still not quite perfect, and EXPERIMENTAL
1173 ## Currently it is assumed that all values passed will be "normal", i.e. not
1174 ## scalar refs, or at least, all the same type as the first set, the statement is
1175 ## only prepped once.
1177 my ($self, $source, $cols, $data) = @_;
1179 my $table = $source->from;
1180 @colvalues{@$cols} = (0..$#$cols);
1181 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1183 $self->_query_start( $sql, @bind );
1184 my $sth = $self->sth($sql);
1186 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1188 ## This must be an arrayref, else nothing works!
1189 my $tuple_status = [];
1191 ## Get the bind_attributes, if any exist
1192 my $bind_attributes = $self->source_bind_attributes($source);
1194 ## Bind the values and execute
1195 my $placeholder_index = 1;
1197 foreach my $bound (@bind) {
1199 my $attributes = {};
1200 my ($column_name, $data_index) = @$bound;
1202 if( $bind_attributes ) {
1203 $attributes = $bind_attributes->{$column_name}
1204 if defined $bind_attributes->{$column_name};
1207 my @data = map { $_->[$data_index] } @$data;
1209 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1210 $placeholder_index++;
1212 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1215 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1217 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1218 if ($i > $#$tuple_status);
1220 require Data::Dumper;
1221 local $Data::Dumper::Terse = 1;
1222 local $Data::Dumper::Indent = 1;
1223 local $Data::Dumper::Useqq = 1;
1224 local $Data::Dumper::Quotekeys = 0;
1226 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1227 $tuple_status->[$i][1],
1228 Data::Dumper::Dumper(
1229 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1233 $self->throw_exception($sth->errstr) if !$rv;
1235 $self->_query_end( $sql, @bind );
1236 return (wantarray ? ($rv, $sth, @bind) : $rv);
1240 my $self = shift @_;
1241 my $source = shift @_;
1242 my $bind_attributes = $self->source_bind_attributes($source);
1244 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1249 my $self = shift @_;
1250 my $source = shift @_;
1252 my $bind_attrs = $self->source_bind_attributes($source);
1254 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1257 # We were sent here because the $rs contains a complex search
1258 # which will require a subquery to select the correct rows
1259 # (i.e. joined or limited resultsets)
1261 # Genarating a single PK column subquery is trivial and supported
1262 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1263 # Look at _multipk_update_delete()
1264 sub _subq_update_delete {
1266 my ($rs, $op, $values) = @_;
1268 my $rsrc = $rs->result_source;
1270 # we already check this, but double check naively just in case. Should be removed soon
1271 my $sel = $rs->_resolved_attrs->{select};
1272 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1273 my @pcols = $rsrc->primary_columns;
1274 if (@$sel != @pcols) {
1275 $self->throw_exception (
1276 'Subquery update/delete can not be called on resultsets selecting a'
1277 .' number of columns different than the number of primary keys'
1284 $op eq 'update' ? $values : (),
1285 { $pcols[0] => { -in => $rs->as_query } },
1290 return $self->_multipk_update_delete (@_);
1294 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1295 # resultset update/delete involving subqueries. So by default resort
1296 # to simple (and inefficient) delete_all style per-row opearations,
1297 # while allowing specific storages to override this with a faster
1300 sub _multipk_update_delete {
1301 return shift->_per_row_update_delete (@_);
1304 # This is the default loop used to delete/update rows for multi PK
1305 # resultsets, and used by mysql exclusively (because it can't do anything
1308 # We do not use $row->$op style queries, because resultset update/delete
1309 # is not expected to cascade (this is what delete_all/update_all is for).
1311 # There should be no race conditions as the entire operation is rolled
1314 sub _per_row_update_delete {
1316 my ($rs, $op, $values) = @_;
1318 my $rsrc = $rs->result_source;
1319 my @pcols = $rsrc->primary_columns;
1321 my $guard = $self->txn_scope_guard;
1323 # emulate the return value of $sth->execute for non-selects
1324 my $row_cnt = '0E0';
1326 my $subrs_cur = $rs->cursor;
1327 while (my @pks = $subrs_cur->next) {
1330 for my $i (0.. $#pcols) {
1331 $cond->{$pcols[$i]} = $pks[$i];
1336 $op eq 'update' ? $values : (),
1351 # localization is neccessary as
1352 # 1) there is no infrastructure to pass this around before SQLA2
1353 # 2) _select_args sets it and _prep_for_execute consumes it
1354 my $sql_maker = $self->sql_maker;
1355 local $sql_maker->{_dbic_rs_attrs};
1357 return $self->_execute($self->_select_args(@_));
1360 sub _select_args_to_query {
1363 # localization is neccessary as
1364 # 1) there is no infrastructure to pass this around before SQLA2
1365 # 2) _select_args sets it and _prep_for_execute consumes it
1366 my $sql_maker = $self->sql_maker;
1367 local $sql_maker->{_dbic_rs_attrs};
1369 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1370 # = $self->_select_args($ident, $select, $cond, $attrs);
1371 my ($op, $bind, $ident, $bind_attrs, @args) =
1372 $self->_select_args(@_);
1374 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1375 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1376 $prepared_bind ||= [];
1379 ? ($sql, $prepared_bind, $bind_attrs)
1380 : \[ "($sql)", @$prepared_bind ]
1385 my ($self, $ident, $select, $where, $attrs) = @_;
1387 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1389 my $sql_maker = $self->sql_maker;
1390 $sql_maker->{_dbic_rs_attrs} = {
1396 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1401 # calculate bind_attrs before possible $ident mangling
1402 my $bind_attrs = {};
1403 for my $alias (keys %$alias2source) {
1404 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1405 for my $col (keys %$bindtypes) {
1407 my $fqcn = join ('.', $alias, $col);
1408 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1410 # so that unqualified searches can be bound too
1411 $bind_attrs->{$col} = $bind_attrs->{$fqcn} if $alias eq $rs_alias;
1417 $attrs->{software_limit}
1419 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1421 $attrs->{software_limit} = 1;
1424 $self->throw_exception("rows attribute must be positive if present")
1425 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1427 # MySQL actually recommends this approach. I cringe.
1428 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1433 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1434 # otherwise delegate the limiting to the storage, unless software limit was requested
1436 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1438 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1439 $attrs->{prefetch_select} && @{$attrs->{prefetch_select}} )
1441 ($ident, $select, $where, $attrs)
1442 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1444 elsif (! $attrs->{software_limit} ) {
1445 push @limit, $attrs->{rows}, $attrs->{offset};
1449 # This would be the point to deflate anything found in $where
1450 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1451 # expect a row object. And all we have is a resultsource (it is trivial
1452 # to extract deflator coderefs via $alias2source above).
1454 # I don't see a way forward other than changing the way deflators are
1455 # invoked, and that's just bad...
1459 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1460 (qw/order_by group_by having/ )
1463 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1467 # This is the code producing joined subqueries like:
1468 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1470 sub _adjust_select_args_for_complex_prefetch {
1471 my ($self, $from, $select, $where, $attrs) = @_;
1473 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1474 if (ref $from ne 'ARRAY');
1476 # copies for mangling
1478 $select = [ @$select ];
1479 $attrs = { %$attrs };
1481 # separate attributes
1482 my $sub_attrs = { %$attrs };
1483 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1484 delete $sub_attrs->{$_} for qw/for collapse prefetch_select _collapse_order_by select as/;
1486 my $alias = $attrs->{alias};
1487 my $sql_maker = $self->sql_maker;
1489 # create subquery select list - consider only stuff *not* brought in by the prefetch
1490 my $sub_select = [];
1491 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{prefetch_select}} - 1) {
1492 my $sel = $attrs->{select}[$i];
1494 # alias any functions to the dbic-side 'as' label
1495 # adjust the outer select accordingly
1496 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1497 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1498 $select->[$i] = join ('.', $attrs->{alias}, ($attrs->{as}[$i] || "select_$i") );
1501 push @$sub_select, $sel;
1504 # bring over all non-collapse-induced order_by into the inner query (if any)
1505 # the outer one will have to keep them all
1506 delete $sub_attrs->{order_by};
1507 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1508 $sub_attrs->{order_by} = [
1509 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1514 my $join_root = shift @$from;
1515 my @outer_from = @$from;
1518 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1520 # in complex search_related chains $alias may *not* be 'me'
1521 # so always include it in the inner join, and also shift away
1522 # from the outer stack, so that the two datasets actually do
1524 if ($join_root->{-alias} ne $alias) {
1525 $inner_joins{$alias} = 1;
1527 while (@outer_from && $outer_from[0][0]{-alias} ne $alias) {
1530 if (! @outer_from) {
1531 $self->throw_exception ("Unable to find '$alias' in the {from} stack, something is wrong");
1534 shift @outer_from; # the new subquery will represent this alias, so get rid of it
1538 # decide which parts of the join will remain on the inside
1540 # this is not a very viable optimisation, but it was written
1541 # before I realised this, so might as well remain. We can throw
1542 # away _any_ branches of the join tree that are:
1543 # 1) not mentioned in the condition/order
1544 # 2) left-join leaves (or left-join leaf chains)
1545 # Most of the join conditions will not satisfy this, but for real
1546 # complex queries some might, and we might make some RDBMS happy.
1549 # since we do not have introspectable SQLA, we fall back to ugly
1550 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1551 # in order to determine what goes into %inner_joins
1552 # It may not be very efficient, but it's a reasonable stop-gap
1554 # produce stuff unquoted, so it can be scanned
1555 local $sql_maker->{quote_char};
1556 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1560 { ref $_ ? $_->[0] : $_ }
1561 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1564 my $where_sql = $sql_maker->where ($where);
1565 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1568 for my $alias (keys %join_info) {
1570 # any table alias found on a column name in where or order_by
1571 # gets included in %inner_joins
1572 # Also any parent joins that are needed to reach this particular alias
1573 for my $piece ($select_sql, $where_sql, @order_by ) {
1574 if ($piece =~ /\b $alias $sep/x) {
1575 $inner_joins{$alias} = 1;
1581 # scan for non-leaf/non-left joins and mark as needed
1582 # also mark all ancestor joins that are needed to reach this particular alias
1583 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1585 # traverse by the size of the -join_path i.e. reverse depth first
1586 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1588 my $j = $join_info{$alias};
1589 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1591 if ($inner_joins{$alias}) {
1592 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1596 # construct the inner $from for the subquery
1597 my $inner_from = [ $join_root ];
1598 for my $j (@$from) {
1599 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1602 # if a multi-type join was needed in the subquery ("multi" is indicated by
1603 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1604 for my $alias (keys %inner_joins) {
1606 # the dot comes from some weirdness in collapse
1607 # remove after the rewrite
1608 if ($attrs->{collapse}{".$alias"}) {
1609 $sub_attrs->{group_by} ||= $sub_select;
1614 # generate the subquery
1615 my $subq = $self->_select_args_to_query (
1622 # put it in the new {from}
1623 unshift @outer_from, {
1625 -source_handle => $join_root->{-source_handle},
1629 # This is totally horrific - the $where ends up in both the inner and outer query
1630 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1631 # then if where conditions apply to the *right* side of the prefetch, you may have
1632 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1633 # the outer select to exclude joins you didin't want in the first place
1635 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1636 return (\@outer_from, $select, $where, $attrs);
1639 sub _resolve_ident_sources {
1640 my ($self, $ident) = @_;
1642 my $alias2source = {};
1645 # the reason this is so contrived is that $ident may be a {from}
1646 # structure, specifying multiple tables to join
1647 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1648 # this is compat mode for insert/update/delete which do not deal with aliases
1649 $alias2source->{me} = $ident;
1652 elsif (ref $ident eq 'ARRAY') {
1656 if (ref $_ eq 'HASH') {
1658 $rs_alias = $tabinfo->{-alias};
1660 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1664 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1665 if ($tabinfo->{-source_handle});
1669 return ($alias2source, $rs_alias);
1672 # Takes $ident, \@column_names
1674 # returns { $column_name => \%column_info, ... }
1675 # also note: this adds -result_source => $rsrc to the column info
1678 # my $col_sources = $self->_resolve_column_info($ident, [map $_->[0], @{$bind}]);
1679 sub _resolve_column_info {
1680 my ($self, $ident, $colnames) = @_;
1681 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1683 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1686 my (%return, %converted);
1687 foreach my $col (@$colnames) {
1688 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1690 # deal with unqualified cols - we assume the main alias for all
1691 # unqualified ones, ugly but can't think of anything better right now
1692 $alias ||= $root_alias;
1694 my $rsrc = $alias2src->{$alias};
1695 $return{$col} = $rsrc && { %{$rsrc->column_info($colname)}, -result_source => $rsrc };
1700 # Returns a counting SELECT for a simple count
1701 # query. Abstracted so that a storage could override
1702 # this to { count => 'firstcol' } or whatever makes
1703 # sense as a performance optimization
1705 #my ($self, $source, $rs_attrs) = @_;
1706 return { count => '*' };
1709 # Returns a SELECT which will end up in the subselect
1710 # There may or may not be a group_by, as the subquery
1711 # might have been called to accomodate a limit
1713 # Most databases would be happy with whatever ends up
1714 # here, but some choke in various ways.
1716 sub _subq_count_select {
1717 my ($self, $source, $rs_attrs) = @_;
1718 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1720 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1721 return @pcols ? \@pcols : [ 1 ];
1725 sub source_bind_attributes {
1726 my ($self, $source) = @_;
1728 my $bind_attributes;
1729 foreach my $column ($source->columns) {
1731 my $data_type = $source->column_info($column)->{data_type} || '';
1732 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1736 return $bind_attributes;
1743 =item Arguments: $ident, $select, $condition, $attrs
1747 Handle a SQL select statement.
1753 my ($ident, $select, $condition, $attrs) = @_;
1754 return $self->cursor_class->new($self, \@_, $attrs);
1759 my ($rv, $sth, @bind) = $self->_select(@_);
1760 my @row = $sth->fetchrow_array;
1761 my @nextrow = $sth->fetchrow_array if @row;
1762 if(@row && @nextrow) {
1763 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1765 # Need to call finish() to work round broken DBDs
1774 =item Arguments: $sql
1778 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1783 my ($self, $dbh, $sql) = @_;
1785 # 3 is the if_active parameter which avoids active sth re-use
1786 my $sth = $self->disable_sth_caching
1787 ? $dbh->prepare($sql)
1788 : $dbh->prepare_cached($sql, {}, 3);
1790 # XXX You would think RaiseError would make this impossible,
1791 # but apparently that's not true :(
1792 $self->throw_exception($dbh->errstr) if !$sth;
1798 my ($self, $sql) = @_;
1799 $self->dbh_do('_dbh_sth', $sql);
1802 sub _dbh_columns_info_for {
1803 my ($self, $dbh, $table) = @_;
1805 if ($dbh->can('column_info')) {
1808 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1809 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1811 while ( my $info = $sth->fetchrow_hashref() ){
1813 $column_info{data_type} = $info->{TYPE_NAME};
1814 $column_info{size} = $info->{COLUMN_SIZE};
1815 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1816 $column_info{default_value} = $info->{COLUMN_DEF};
1817 my $col_name = $info->{COLUMN_NAME};
1818 $col_name =~ s/^\"(.*)\"$/$1/;
1820 $result{$col_name} = \%column_info;
1823 return \%result if !$@ && scalar keys %result;
1827 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1829 my @columns = @{$sth->{NAME_lc}};
1830 for my $i ( 0 .. $#columns ){
1832 $column_info{data_type} = $sth->{TYPE}->[$i];
1833 $column_info{size} = $sth->{PRECISION}->[$i];
1834 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1836 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1837 $column_info{data_type} = $1;
1838 $column_info{size} = $2;
1841 $result{$columns[$i]} = \%column_info;
1845 foreach my $col (keys %result) {
1846 my $colinfo = $result{$col};
1847 my $type_num = $colinfo->{data_type};
1849 if(defined $type_num && $dbh->can('type_info')) {
1850 my $type_info = $dbh->type_info($type_num);
1851 $type_name = $type_info->{TYPE_NAME} if $type_info;
1852 $colinfo->{data_type} = $type_name if $type_name;
1859 sub columns_info_for {
1860 my ($self, $table) = @_;
1861 $self->dbh_do('_dbh_columns_info_for', $table);
1864 =head2 last_insert_id
1866 Return the row id of the last insert.
1870 sub _dbh_last_insert_id {
1871 # All Storage's need to register their own _dbh_last_insert_id
1872 # the old SQLite-based method was highly inappropriate
1875 my $class = ref $self;
1876 $self->throw_exception (<<EOE);
1878 No _dbh_last_insert_id() method found in $class.
1879 Since the method of obtaining the autoincrement id of the last insert
1880 operation varies greatly between different databases, this method must be
1881 individually implemented for every storage class.
1885 sub last_insert_id {
1887 $self->dbh_do('_dbh_last_insert_id', @_);
1892 Returns the database driver name.
1896 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1898 =head2 bind_attribute_by_data_type
1900 Given a datatype from column info, returns a database specific bind
1901 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1902 let the database planner just handle it.
1904 Generally only needed for special case column types, like bytea in postgres.
1908 sub bind_attribute_by_data_type {
1912 =head2 is_datatype_numeric
1914 Given a datatype from column_info, returns a boolean value indicating if
1915 the current RDBMS considers it a numeric value. This controls how
1916 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1917 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1918 be performed instead of the usual C<eq>.
1922 sub is_datatype_numeric {
1923 my ($self, $dt) = @_;
1925 return 0 unless $dt;
1927 return $dt =~ /^ (?:
1928 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
1933 =head2 create_ddl_dir (EXPERIMENTAL)
1937 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1941 Creates a SQL file based on the Schema, for each of the specified
1942 database engines in C<\@databases> in the given directory.
1943 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1945 Given a previous version number, this will also create a file containing
1946 the ALTER TABLE statements to transform the previous schema into the
1947 current one. Note that these statements may contain C<DROP TABLE> or
1948 C<DROP COLUMN> statements that can potentially destroy data.
1950 The file names are created using the C<ddl_filename> method below, please
1951 override this method in your schema if you would like a different file
1952 name format. For the ALTER file, the same format is used, replacing
1953 $version in the name with "$preversion-$version".
1955 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1956 The most common value for this would be C<< { add_drop_table => 1 } >>
1957 to have the SQL produced include a C<DROP TABLE> statement for each table
1958 created. For quoting purposes supply C<quote_table_names> and
1959 C<quote_field_names>.
1961 If no arguments are passed, then the following default values are assumed:
1965 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1967 =item version - $schema->schema_version
1969 =item directory - './'
1971 =item preversion - <none>
1975 By default, C<\%sqlt_args> will have
1977 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1979 merged with the hash passed in. To disable any of those features, pass in a
1980 hashref like the following
1982 { ignore_constraint_names => 0, # ... other options }
1985 Note that this feature is currently EXPERIMENTAL and may not work correctly
1986 across all databases, or fully handle complex relationships.
1988 WARNING: Please check all SQL files created, before applying them.
1992 sub create_ddl_dir {
1993 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1995 if(!$dir || !-d $dir) {
1996 carp "No directory given, using ./\n";
1999 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2000 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2002 my $schema_version = $schema->schema_version || '1.x';
2003 $version ||= $schema_version;
2006 add_drop_table => 1,
2007 ignore_constraint_names => 1,
2008 ignore_index_names => 1,
2012 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2013 . $self->_check_sqlt_message . q{'})
2014 if !$self->_check_sqlt_version;
2016 my $sqlt = SQL::Translator->new( $sqltargs );
2018 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2019 my $sqlt_schema = $sqlt->translate({ data => $schema })
2020 or $self->throw_exception ($sqlt->error);
2022 foreach my $db (@$databases) {
2024 $sqlt->{schema} = $sqlt_schema;
2025 $sqlt->producer($db);
2028 my $filename = $schema->ddl_filename($db, $version, $dir);
2029 if (-e $filename && ($version eq $schema_version )) {
2030 # if we are dumping the current version, overwrite the DDL
2031 carp "Overwriting existing DDL file - $filename";
2035 my $output = $sqlt->translate;
2037 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2040 if(!open($file, ">$filename")) {
2041 $self->throw_exception("Can't open $filename for writing ($!)");
2044 print $file $output;
2047 next unless ($preversion);
2049 require SQL::Translator::Diff;
2051 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2052 if(!-e $prefilename) {
2053 carp("No previous schema file found ($prefilename)");
2057 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2059 carp("Overwriting existing diff file - $difffile");
2065 my $t = SQL::Translator->new($sqltargs);
2070 or $self->throw_exception ($t->error);
2072 my $out = $t->translate( $prefilename )
2073 or $self->throw_exception ($t->error);
2075 $source_schema = $t->schema;
2077 $source_schema->name( $prefilename )
2078 unless ( $source_schema->name );
2081 # The "new" style of producers have sane normalization and can support
2082 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2083 # And we have to diff parsed SQL against parsed SQL.
2084 my $dest_schema = $sqlt_schema;
2086 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2087 my $t = SQL::Translator->new($sqltargs);
2092 or $self->throw_exception ($t->error);
2094 my $out = $t->translate( $filename )
2095 or $self->throw_exception ($t->error);
2097 $dest_schema = $t->schema;
2099 $dest_schema->name( $filename )
2100 unless $dest_schema->name;
2103 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2107 if(!open $file, ">$difffile") {
2108 $self->throw_exception("Can't write to $difffile ($!)");
2116 =head2 deployment_statements
2120 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2124 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2126 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2127 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2129 C<$directory> is used to return statements from files in a previously created
2130 L</create_ddl_dir> directory and is optional. The filenames are constructed
2131 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2133 If no C<$directory> is specified then the statements are constructed on the
2134 fly using L<SQL::Translator> and C<$version> is ignored.
2136 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2140 sub deployment_statements {
2141 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2142 # Need to be connected to get the correct sqlt_type
2143 $self->ensure_connected() unless $type;
2144 $type ||= $self->sqlt_type;
2145 $version ||= $schema->schema_version || '1.x';
2147 my $filename = $schema->ddl_filename($type, $version, $dir);
2151 open($file, "<$filename")
2152 or $self->throw_exception("Can't open $filename ($!)");
2155 return join('', @rows);
2158 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2159 . $self->_check_sqlt_message . q{'})
2160 if !$self->_check_sqlt_version;
2162 require SQL::Translator::Parser::DBIx::Class;
2163 eval qq{use SQL::Translator::Producer::${type}};
2164 $self->throw_exception($@) if $@;
2166 # sources needs to be a parser arg, but for simplicty allow at top level
2168 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2169 if exists $sqltargs->{sources};
2171 my $tr = SQL::Translator->new(%$sqltargs);
2172 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2173 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2177 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2180 return if($line =~ /^--/);
2182 # next if($line =~ /^DROP/m);
2183 return if($line =~ /^BEGIN TRANSACTION/m);
2184 return if($line =~ /^COMMIT/m);
2185 return if $line =~ /^\s+$/; # skip whitespace only
2186 $self->_query_start($line);
2188 $self->dbh->do($line); # shouldn't be using ->dbh ?
2191 carp qq{$@ (running "${line}")};
2193 $self->_query_end($line);
2195 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2196 if (@statements > 1) {
2197 foreach my $statement (@statements) {
2198 $deploy->( $statement );
2201 elsif (@statements == 1) {
2202 foreach my $line ( split(";\n", $statements[0])) {
2208 =head2 datetime_parser
2210 Returns the datetime parser class
2214 sub datetime_parser {
2216 return $self->{datetime_parser} ||= do {
2217 $self->ensure_connected;
2218 $self->build_datetime_parser(@_);
2222 =head2 datetime_parser_type
2224 Defines (returns) the datetime parser class - currently hardwired to
2225 L<DateTime::Format::MySQL>
2229 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2231 =head2 build_datetime_parser
2233 See L</datetime_parser>
2237 sub build_datetime_parser {
2239 my $type = $self->datetime_parser_type(@_);
2241 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2246 my $_check_sqlt_version; # private
2247 my $_check_sqlt_message; # private
2248 sub _check_sqlt_version {
2249 return $_check_sqlt_version if defined $_check_sqlt_version;
2250 eval 'use SQL::Translator "0.09003"';
2251 $_check_sqlt_message = $@ || '';
2252 $_check_sqlt_version = !$@;
2255 sub _check_sqlt_message {
2256 _check_sqlt_version if !defined $_check_sqlt_message;
2257 $_check_sqlt_message;
2261 =head2 is_replicating
2263 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2264 replicate from a master database. Default is undef, which is the result
2265 returned by databases that don't support replication.
2269 sub is_replicating {
2274 =head2 lag_behind_master
2276 Returns a number that represents a certain amount of lag behind a master db
2277 when a given storage is replicating. The number is database dependent, but
2278 starts at zero and increases with the amount of lag. Default in undef
2282 sub lag_behind_master {
2288 return if !$self->_dbh;
2297 =head2 DBIx::Class and AutoCommit
2299 DBIx::Class can do some wonderful magic with handling exceptions,
2300 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2301 combined with C<txn_do> for transaction support.
2303 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2304 in an assumed transaction between commits, and you're telling us you'd
2305 like to manage that manually. A lot of the magic protections offered by
2306 this module will go away. We can't protect you from exceptions due to database
2307 disconnects because we don't know anything about how to restart your
2308 transactions. You're on your own for handling all sorts of exceptional
2309 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2316 Matt S. Trout <mst@shadowcatsystems.co.uk>
2318 Andy Grundman <andy@hybridized.org>
2322 You may distribute this code under the same terms as Perl itself.