1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
4 use base 'DBIx::Class::Storage';
8 use Carp::Clan qw/^DBIx::Class/;
10 use DBIx::Class::Storage::DBI::Cursor;
11 use DBIx::Class::Storage::Statistics;
15 __PACKAGE__->mk_group_accessors('simple' =>
16 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts
17 _conn_pid _conn_tid transaction_depth _dbh_autocommit savepoints/
20 # the values for these accessors are picked out (and deleted) from
21 # the attribute hashref passed to connect_info
22 my @storage_options = qw/
23 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
24 disable_sth_caching unsafe auto_savepoint
26 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
29 # default cursor class, overridable in connect_info attributes
30 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
32 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
33 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
38 DBIx::Class::Storage::DBI - DBI storage handler
42 my $schema = MySchema->connect('dbi:SQLite:my.db');
44 $schema->storage->debug(1);
45 $schema->dbh_do("DROP TABLE authors");
47 $schema->resultset('Book')->search({
48 written_on => $schema->storage->datetime_parser(DateTime->now)
53 This class represents the connection to an RDBMS via L<DBI>. See
54 L<DBIx::Class::Storage> for general information. This pod only
55 documents DBI-specific methods and behaviors.
62 my $new = shift->next::method(@_);
64 $new->transaction_depth(0);
65 $new->_sql_maker_opts({});
66 $new->{savepoints} = [];
67 $new->{_in_dbh_do} = 0;
75 This method is normally called by L<DBIx::Class::Schema/connection>, which
76 encapsulates its argument list in an arrayref before passing them here.
78 The argument list may contain:
84 The same 4-element argument set one would normally pass to
85 L<DBI/connect>, optionally followed by
86 L<extra attributes|/DBIx::Class specific connection attributes>
87 recognized by DBIx::Class:
89 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
93 A single code reference which returns a connected
94 L<DBI database handle|DBI/connect> optionally followed by
95 L<extra attributes|/DBIx::Class specific connection attributes> recognized
98 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
102 A single hashref with all the attributes and the dsn/user/password
105 $connect_info_args = [{
113 This is particularly useful for L<Catalyst> based applications, allowing the
114 following config (L<Config::General> style):
119 dsn dbi:mysql:database=test
128 Please note that the L<DBI> docs recommend that you always explicitly
129 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
130 recommends that it be set to I<1>, and that you perform transactions
131 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
132 to I<1> if you do not do explicitly set it to zero. This is the default
133 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
135 =head3 DBIx::Class specific connection attributes
137 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
138 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
139 the following connection options. These options can be mixed in with your other
140 L<DBI> connection attributes, or placed in a seperate hashref
141 (C<\%extra_attributes>) as shown above.
143 Every time C<connect_info> is invoked, any previous settings for
144 these options will be cleared before setting the new ones, regardless of
145 whether any options are specified in the new C<connect_info>.
152 Specifies things to do immediately after connecting or re-connecting to
153 the database. Its value may contain:
159 This contains one SQL statement to execute.
161 =item an array reference
163 This contains SQL statements to execute in order. Each element contains
164 a string or a code reference that returns a string.
166 =item a code reference
168 This contains some code to execute. Unlike code references within an
169 array reference, its return value is ignored.
173 =item on_disconnect_do
175 Takes arguments in the same form as L</on_connect_do> and executes them
176 immediately before disconnecting from the database.
178 Note, this only runs if you explicitly call L</disconnect> on the
181 =item on_connect_call
183 A more generalized form of L</on_connect_do> that calls the specified
184 C<connect_call_METHOD> methods in your storage driver.
186 on_connect_do => 'select 1'
190 on_connect_call => [ [ do_sql => 'select 1' ] ]
192 Its values may contain:
198 Will call the C<connect_call_METHOD> method.
200 =item a code reference
202 Will execute C<< $code->($storage) >>
204 =item an array reference
206 Each value can be a method name or code reference.
208 =item an array of arrays
210 For each array, the first item is taken to be the C<connect_call_> method name
211 or code reference, and the rest are parameters to it.
215 Some predefined storage methods you may use:
221 Executes a SQL string or a code reference that returns a SQL string. This is
222 what L</on_connect_do> and L</on_disconnect_do> use.
230 Will execute the scalar as SQL.
234 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
235 attributes hashref and bind values.
237 =item a code reference
239 Will execute C<< $code->($storage) >> and execute the return array refs as
246 Execute any statements necessary to initialize the database session to return
247 and accept datetime/timestamp values used with
248 L<DBIx::Class::InflateColumn::DateTime>.
250 Only necessary for some databases, see your specific storage driver for
251 implementation details.
255 =item on_disconnect_call
257 Takes arguments in the same form as L</on_connect_call> and executes them
258 immediately before disconnecting from the database.
260 Calls the C<disconnect_call_METHOD> methods as opposed to the
261 C<connect_call_METHOD> methods called by L</on_connect_call>.
263 Note, this only runs if you explicitly call L</disconnect> on the
266 =item disable_sth_caching
268 If set to a true value, this option will disable the caching of
269 statement handles via L<DBI/prepare_cached>.
273 Sets the limit dialect. This is useful for JDBC-bridge among others
274 where the remote SQL-dialect cannot be determined by the name of the
275 driver alone. See also L<SQL::Abstract::Limit>.
279 Specifies what characters to use to quote table and column names. If
280 you use this you will want to specify L</name_sep> as well.
282 C<quote_char> expects either a single character, in which case is it
283 is placed on either side of the table/column name, or an arrayref of length
284 2 in which case the table/column name is placed between the elements.
286 For example under MySQL you should use C<< quote_char => '`' >>, and for
287 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
291 This only needs to be used in conjunction with C<quote_char>, and is used to
292 specify the charecter that seperates elements (schemas, tables, columns) from
293 each other. In most cases this is simply a C<.>.
295 The consequences of not supplying this value is that L<SQL::Abstract>
296 will assume DBIx::Class' uses of aliases to be complete column
297 names. The output will look like I<"me.name"> when it should actually
302 This Storage driver normally installs its own C<HandleError>, sets
303 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
304 all database handles, including those supplied by a coderef. It does this
305 so that it can have consistent and useful error behavior.
307 If you set this option to a true value, Storage will not do its usual
308 modifications to the database handle's attributes, and instead relies on
309 the settings in your connect_info DBI options (or the values you set in
310 your connection coderef, in the case that you are connecting via coderef).
312 Note that your custom settings can cause Storage to malfunction,
313 especially if you set a C<HandleError> handler that suppresses exceptions
314 and/or disable C<RaiseError>.
318 If this option is true, L<DBIx::Class> will use savepoints when nesting
319 transactions, making it possible to recover from failure in the inner
320 transaction without having to abort all outer transactions.
324 Use this argument to supply a cursor class other than the default
325 L<DBIx::Class::Storage::DBI::Cursor>.
329 Some real-life examples of arguments to L</connect_info> and
330 L<DBIx::Class::Schema/connect>
332 # Simple SQLite connection
333 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
336 ->connect_info([ sub { DBI->connect(...) } ]);
338 # A bit more complicated
345 { quote_char => q{"}, name_sep => q{.} },
349 # Equivalent to the previous example
355 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
359 # Same, but with hashref as argument
360 # See parse_connect_info for explanation
363 dsn => 'dbi:Pg:dbname=foo',
365 password => 'my_pg_password',
372 # Subref + DBIx::Class-specific connection options
375 sub { DBI->connect(...) },
379 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
380 disable_sth_caching => 1,
390 my ($self, $info_arg) = @_;
392 return $self->_connect_info if !$info_arg;
394 my @args = @$info_arg; # take a shallow copy for further mutilation
395 $self->_connect_info([@args]); # copy for _connect_info
398 # combine/pre-parse arguments depending on invocation style
401 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
402 %attrs = %{ $args[1] || {} };
405 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
406 %attrs = %{$args[0]};
408 for (qw/password user dsn/) {
409 unshift @args, delete $attrs{$_};
412 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
414 % { $args[3] || {} },
415 % { $args[4] || {} },
417 @args = @args[0,1,2];
420 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
421 # the new set of options
422 $self->_sql_maker(undef);
423 $self->_sql_maker_opts({});
426 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
427 if(my $value = delete $attrs{$storage_opt}) {
428 $self->$storage_opt($value);
431 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
432 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
433 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
438 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
440 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
441 $self->_connect_info;
446 This method is deprecated in favour of setting via L</connect_info>.
450 =head2 on_disconnect_do
452 This method is deprecated in favour of setting via L</connect_info>.
456 sub _parse_connect_do {
457 my ($self, $type) = @_;
459 my $val = $self->$type;
460 return () if not defined $val;
465 push @res, [ 'do_sql', $val ];
466 } elsif (ref($val) eq 'CODE') {
468 } elsif (ref($val) eq 'ARRAY') {
469 push @res, map { [ 'do_sql', $_ ] } @$val;
471 $self->throw_exception("Invalid type for $type: ".ref($val));
479 Arguments: ($subref | $method_name), @extra_coderef_args?
481 Execute the given $subref or $method_name using the new exception-based
482 connection management.
484 The first two arguments will be the storage object that C<dbh_do> was called
485 on and a database handle to use. Any additional arguments will be passed
486 verbatim to the called subref as arguments 2 and onwards.
488 Using this (instead of $self->_dbh or $self->dbh) ensures correct
489 exception handling and reconnection (or failover in future subclasses).
491 Your subref should have no side-effects outside of the database, as
492 there is the potential for your subref to be partially double-executed
493 if the database connection was stale/dysfunctional.
497 my @stuff = $schema->storage->dbh_do(
499 my ($storage, $dbh, @cols) = @_;
500 my $cols = join(q{, }, @cols);
501 $dbh->selectrow_array("SELECT $cols FROM foo");
512 my $dbh = $self->_dbh;
514 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
515 || $self->{transaction_depth};
517 local $self->{_in_dbh_do} = 1;
520 my $want_array = wantarray;
523 $self->_verify_pid if $dbh;
525 $self->_populate_dbh;
530 @result = $self->$code($dbh, @_);
532 elsif(defined $want_array) {
533 $result[0] = $self->$code($dbh, @_);
536 $self->$code($dbh, @_);
541 if(!$exception) { return $want_array ? @result : $result[0] }
543 $self->throw_exception($exception) if $self->connected;
545 # We were not connected - reconnect and retry, but let any
546 # exception fall right through this time
547 $self->_populate_dbh;
548 $self->$code($self->_dbh, @_);
551 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
552 # It also informs dbh_do to bypass itself while under the direction of txn_do,
553 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
558 ref $coderef eq 'CODE' or $self->throw_exception
559 ('$coderef must be a CODE reference');
561 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
563 local $self->{_in_dbh_do} = 1;
566 my $want_array = wantarray;
571 $self->_verify_pid if $self->_dbh;
572 $self->_populate_dbh if !$self->_dbh;
576 @result = $coderef->(@_);
578 elsif(defined $want_array) {
579 $result[0] = $coderef->(@_);
588 if(!$exception) { return $want_array ? @result : $result[0] }
590 if($tried++ > 0 || $self->connected) {
591 eval { $self->txn_rollback };
592 my $rollback_exception = $@;
593 if($rollback_exception) {
594 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
595 $self->throw_exception($exception) # propagate nested rollback
596 if $rollback_exception =~ /$exception_class/;
598 $self->throw_exception(
599 "Transaction aborted: ${exception}. "
600 . "Rollback failed: ${rollback_exception}"
603 $self->throw_exception($exception)
606 # We were not connected, and was first try - reconnect and retry
608 $self->_populate_dbh;
614 Our C<disconnect> method also performs a rollback first if the
615 database is not in C<AutoCommit> mode.
622 if( $self->connected ) {
625 push @actions, ( $self->on_disconnect_call || () );
626 push @actions, $self->_parse_connect_do ('on_disconnect_do');
628 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
630 $self->_dbh->rollback unless $self->_dbh_autocommit;
631 $self->_dbh->disconnect;
637 =head2 with_deferred_fk_checks
641 =item Arguments: C<$coderef>
643 =item Return Value: The return value of $coderef
647 Storage specific method to run the code ref with FK checks deferred or
648 in MySQL's case disabled entirely.
652 # Storage subclasses should override this
653 sub with_deferred_fk_checks {
654 my ($self, $sub) = @_;
662 if(my $dbh = $self->_dbh) {
663 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
670 return 0 if !$self->_dbh;
672 return ($dbh->FETCH('Active') && $self->_ping);
681 my $dbh = $self->_dbh or return 0;
686 # handle pid changes correctly
687 # NOTE: assumes $self->_dbh is a valid $dbh
691 return if defined $self->_conn_pid && $self->_conn_pid == $$;
693 $self->_dbh->{InactiveDestroy} = 1;
700 sub ensure_connected {
703 unless ($self->connected) {
704 $self->_populate_dbh;
710 Returns the dbh - a data base handle of class L<DBI>.
717 $self->ensure_connected;
721 sub _sql_maker_args {
724 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
729 unless ($self->_sql_maker) {
730 my $sql_maker_class = $self->sql_maker_class;
731 $self->ensure_class_loaded ($sql_maker_class);
732 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
734 return $self->_sql_maker;
741 my @info = @{$self->_dbi_connect_info || []};
742 $self->_dbh($self->_connect(@info));
744 $self->_conn_pid($$);
745 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
747 $self->_determine_driver;
749 # Always set the transaction depth on connect, since
750 # there is no transaction in progress by definition
751 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
755 push @actions, ( $self->on_connect_call || () );
756 push @actions, $self->_parse_connect_do ('on_connect_do');
758 $self->_do_connection_actions(connect_call_ => $_) for @actions;
761 sub _determine_driver {
764 if (ref $self eq 'DBIx::Class::Storage::DBI') {
767 if ($self->_dbh) { # we are connected
768 $driver = $self->_dbh->{Driver}{Name};
770 # try to use dsn to not require being connected, the driver may still
771 # force a connection in _rebless to determine version
772 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
775 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
776 if ($self->load_optional_class($storage_class)) {
777 mro::set_mro($storage_class, 'c3');
778 bless $self, $storage_class;
784 sub _do_connection_actions {
786 my $method_prefix = shift;
789 if (not ref($call)) {
790 my $method = $method_prefix . $call;
792 } elsif (ref($call) eq 'CODE') {
794 } elsif (ref($call) eq 'ARRAY') {
795 if (ref($call->[0]) ne 'ARRAY') {
796 $self->_do_connection_actions($method_prefix, $_) for @$call;
798 $self->_do_connection_actions($method_prefix, @$_) for @$call;
801 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
807 sub connect_call_do_sql {
809 $self->_do_query(@_);
812 sub disconnect_call_do_sql {
814 $self->_do_query(@_);
817 # override in db-specific backend when necessary
818 sub connect_call_datetime_setup { 1 }
821 my ($self, $action) = @_;
823 if (ref $action eq 'CODE') {
824 $action = $action->($self);
825 $self->_do_query($_) foreach @$action;
828 # Most debuggers expect ($sql, @bind), so we need to exclude
829 # the attribute hash which is the second argument to $dbh->do
830 # furthermore the bind values are usually to be presented
831 # as named arrayref pairs, so wrap those here too
832 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
833 my $sql = shift @do_args;
834 my $attrs = shift @do_args;
835 my @bind = map { [ undef, $_ ] } @do_args;
837 $self->_query_start($sql, @bind);
838 $self->_dbh->do($sql, $attrs, @do_args);
839 $self->_query_end($sql, @bind);
846 my ($self, @info) = @_;
848 $self->throw_exception("You failed to provide any connection info")
851 my ($old_connect_via, $dbh);
853 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
854 $old_connect_via = $DBI::connect_via;
855 $DBI::connect_via = 'connect';
859 if(ref $info[0] eq 'CODE') {
863 $dbh = DBI->connect(@info);
866 if($dbh && !$self->unsafe) {
867 my $weak_self = $self;
868 Scalar::Util::weaken($weak_self);
869 $dbh->{HandleError} = sub {
871 $weak_self->throw_exception("DBI Exception: $_[0]");
874 croak ("DBI Exception: $_[0]");
877 $dbh->{ShowErrorStatement} = 1;
878 $dbh->{RaiseError} = 1;
879 $dbh->{PrintError} = 0;
883 $DBI::connect_via = $old_connect_via if $old_connect_via;
885 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
888 $self->_dbh_autocommit($dbh->{AutoCommit});
894 my ($self, $name) = @_;
896 $name = $self->_svp_generate_name
897 unless defined $name;
899 $self->throw_exception ("You can't use savepoints outside a transaction")
900 if $self->{transaction_depth} == 0;
902 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
903 unless $self->can('_svp_begin');
905 push @{ $self->{savepoints} }, $name;
907 $self->debugobj->svp_begin($name) if $self->debug;
909 return $self->_svp_begin($name);
913 my ($self, $name) = @_;
915 $self->throw_exception ("You can't use savepoints outside a transaction")
916 if $self->{transaction_depth} == 0;
918 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
919 unless $self->can('_svp_release');
922 $self->throw_exception ("Savepoint '$name' does not exist")
923 unless grep { $_ eq $name } @{ $self->{savepoints} };
925 # Dig through the stack until we find the one we are releasing. This keeps
926 # the stack up to date.
929 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
931 $name = pop @{ $self->{savepoints} };
934 $self->debugobj->svp_release($name) if $self->debug;
936 return $self->_svp_release($name);
940 my ($self, $name) = @_;
942 $self->throw_exception ("You can't use savepoints outside a transaction")
943 if $self->{transaction_depth} == 0;
945 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
946 unless $self->can('_svp_rollback');
949 # If they passed us a name, verify that it exists in the stack
950 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
951 $self->throw_exception("Savepoint '$name' does not exist!");
954 # Dig through the stack until we find the one we are releasing. This keeps
955 # the stack up to date.
956 while(my $s = pop(@{ $self->{savepoints} })) {
957 last if($s eq $name);
959 # Add the savepoint back to the stack, as a rollback doesn't remove the
960 # named savepoint, only everything after it.
961 push(@{ $self->{savepoints} }, $name);
963 # We'll assume they want to rollback to the last savepoint
964 $name = $self->{savepoints}->[-1];
967 $self->debugobj->svp_rollback($name) if $self->debug;
969 return $self->_svp_rollback($name);
972 sub _svp_generate_name {
975 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
980 $self->ensure_connected();
981 if($self->{transaction_depth} == 0) {
982 $self->debugobj->txn_begin()
984 # this isn't ->_dbh-> because
985 # we should reconnect on begin_work
986 # for AutoCommit users
987 $self->dbh->begin_work;
988 } elsif ($self->auto_savepoint) {
991 $self->{transaction_depth}++;
996 if ($self->{transaction_depth} == 1) {
997 my $dbh = $self->_dbh;
998 $self->debugobj->txn_commit()
1001 $self->{transaction_depth} = 0
1002 if $self->_dbh_autocommit;
1004 elsif($self->{transaction_depth} > 1) {
1005 $self->{transaction_depth}--;
1007 if $self->auto_savepoint;
1013 my $dbh = $self->_dbh;
1015 if ($self->{transaction_depth} == 1) {
1016 $self->debugobj->txn_rollback()
1018 $self->{transaction_depth} = 0
1019 if $self->_dbh_autocommit;
1022 elsif($self->{transaction_depth} > 1) {
1023 $self->{transaction_depth}--;
1024 if ($self->auto_savepoint) {
1025 $self->svp_rollback;
1030 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1035 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1036 $error =~ /$exception_class/ and $self->throw_exception($error);
1037 # ensure that a failed rollback resets the transaction depth
1038 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1039 $self->throw_exception($error);
1043 # This used to be the top-half of _execute. It was split out to make it
1044 # easier to override in NoBindVars without duping the rest. It takes up
1045 # all of _execute's args, and emits $sql, @bind.
1046 sub _prep_for_execute {
1047 my ($self, $op, $extra_bind, $ident, $args) = @_;
1049 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1050 $ident = $ident->from();
1053 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1056 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1058 return ($sql, \@bind);
1062 sub _fix_bind_params {
1063 my ($self, @bind) = @_;
1065 ### Turn @bind from something like this:
1066 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1068 ### ( "'1'", "'1'", "'3'" )
1071 if ( defined( $_ && $_->[1] ) ) {
1072 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1079 my ( $self, $sql, @bind ) = @_;
1081 if ( $self->debug ) {
1082 @bind = $self->_fix_bind_params(@bind);
1084 $self->debugobj->query_start( $sql, @bind );
1089 my ( $self, $sql, @bind ) = @_;
1091 if ( $self->debug ) {
1092 @bind = $self->_fix_bind_params(@bind);
1093 $self->debugobj->query_end( $sql, @bind );
1098 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1100 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1102 $self->_query_start( $sql, @$bind );
1104 my $sth = $self->sth($sql,$op);
1106 my $placeholder_index = 1;
1108 foreach my $bound (@$bind) {
1109 my $attributes = {};
1110 my($column_name, @data) = @$bound;
1112 if ($bind_attributes) {
1113 $attributes = $bind_attributes->{$column_name}
1114 if defined $bind_attributes->{$column_name};
1117 foreach my $data (@data) {
1118 my $ref = ref $data;
1119 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1121 $sth->bind_param($placeholder_index, $data, $attributes);
1122 $placeholder_index++;
1126 # Can this fail without throwing an exception anyways???
1127 my $rv = $sth->execute();
1128 $self->throw_exception($sth->errstr) if !$rv;
1130 $self->_query_end( $sql, @$bind );
1132 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1137 $self->dbh_do('_dbh_execute', @_)
1141 my ($self, $source, $to_insert) = @_;
1143 my $ident = $source->from;
1144 my $bind_attributes = $self->source_bind_attributes($source);
1146 my $updated_cols = {};
1148 $self->ensure_connected;
1149 foreach my $col ( $source->columns ) {
1150 if ( !defined $to_insert->{$col} ) {
1151 my $col_info = $source->column_info($col);
1153 if ( $col_info->{auto_nextval} ) {
1154 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1159 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1161 return $updated_cols;
1164 ## Still not quite perfect, and EXPERIMENTAL
1165 ## Currently it is assumed that all values passed will be "normal", i.e. not
1166 ## scalar refs, or at least, all the same type as the first set, the statement is
1167 ## only prepped once.
1169 my ($self, $source, $cols, $data) = @_;
1171 my $table = $source->from;
1172 @colvalues{@$cols} = (0..$#$cols);
1173 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1175 $self->_query_start( $sql, @bind );
1176 my $sth = $self->sth($sql);
1178 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1180 ## This must be an arrayref, else nothing works!
1181 my $tuple_status = [];
1183 ## Get the bind_attributes, if any exist
1184 my $bind_attributes = $self->source_bind_attributes($source);
1186 ## Bind the values and execute
1187 my $placeholder_index = 1;
1189 foreach my $bound (@bind) {
1191 my $attributes = {};
1192 my ($column_name, $data_index) = @$bound;
1194 if( $bind_attributes ) {
1195 $attributes = $bind_attributes->{$column_name}
1196 if defined $bind_attributes->{$column_name};
1199 my @data = map { $_->[$data_index] } @$data;
1201 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1202 $placeholder_index++;
1204 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1207 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1209 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1210 if ($i > $#$tuple_status);
1212 require Data::Dumper;
1213 local $Data::Dumper::Terse = 1;
1214 local $Data::Dumper::Indent = 1;
1215 local $Data::Dumper::Useqq = 1;
1216 local $Data::Dumper::Quotekeys = 0;
1218 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1219 $tuple_status->[$i][1],
1220 Data::Dumper::Dumper(
1221 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1225 $self->throw_exception($sth->errstr) if !$rv;
1227 $self->_query_end( $sql, @bind );
1228 return (wantarray ? ($rv, $sth, @bind) : $rv);
1232 my $self = shift @_;
1233 my $source = shift @_;
1234 my $bind_attributes = $self->source_bind_attributes($source);
1236 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1241 my $self = shift @_;
1242 my $source = shift @_;
1244 my $bind_attrs = $self->source_bind_attributes($source);
1246 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1249 # We were sent here because the $rs contains a complex search
1250 # which will require a subquery to select the correct rows
1251 # (i.e. joined or limited resultsets)
1253 # Genarating a single PK column subquery is trivial and supported
1254 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1255 # Look at _multipk_update_delete()
1256 sub _subq_update_delete {
1258 my ($rs, $op, $values) = @_;
1260 my $rsrc = $rs->result_source;
1262 # we already check this, but double check naively just in case. Should be removed soon
1263 my $sel = $rs->_resolved_attrs->{select};
1264 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1265 my @pcols = $rsrc->primary_columns;
1266 if (@$sel != @pcols) {
1267 $self->throw_exception (
1268 'Subquery update/delete can not be called on resultsets selecting a'
1269 .' number of columns different than the number of primary keys'
1276 $op eq 'update' ? $values : (),
1277 { $pcols[0] => { -in => $rs->as_query } },
1282 return $self->_multipk_update_delete (@_);
1286 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1287 # resultset update/delete involving subqueries. So by default resort
1288 # to simple (and inefficient) delete_all style per-row opearations,
1289 # while allowing specific storages to override this with a faster
1292 sub _multipk_update_delete {
1293 return shift->_per_row_update_delete (@_);
1296 # This is the default loop used to delete/update rows for multi PK
1297 # resultsets, and used by mysql exclusively (because it can't do anything
1300 # We do not use $row->$op style queries, because resultset update/delete
1301 # is not expected to cascade (this is what delete_all/update_all is for).
1303 # There should be no race conditions as the entire operation is rolled
1306 sub _per_row_update_delete {
1308 my ($rs, $op, $values) = @_;
1310 my $rsrc = $rs->result_source;
1311 my @pcols = $rsrc->primary_columns;
1313 my $guard = $self->txn_scope_guard;
1315 # emulate the return value of $sth->execute for non-selects
1316 my $row_cnt = '0E0';
1318 my $subrs_cur = $rs->cursor;
1319 while (my @pks = $subrs_cur->next) {
1322 for my $i (0.. $#pcols) {
1323 $cond->{$pcols[$i]} = $pks[$i];
1328 $op eq 'update' ? $values : (),
1343 # localization is neccessary as
1344 # 1) there is no infrastructure to pass this around before SQLA2
1345 # 2) _select_args sets it and _prep_for_execute consumes it
1346 my $sql_maker = $self->sql_maker;
1347 local $sql_maker->{_dbic_rs_attrs};
1349 return $self->_execute($self->_select_args(@_));
1352 sub _select_args_to_query {
1355 # localization is neccessary as
1356 # 1) there is no infrastructure to pass this around before SQLA2
1357 # 2) _select_args sets it and _prep_for_execute consumes it
1358 my $sql_maker = $self->sql_maker;
1359 local $sql_maker->{_dbic_rs_attrs};
1361 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1362 # = $self->_select_args($ident, $select, $cond, $attrs);
1363 my ($op, $bind, $ident, $bind_attrs, @args) =
1364 $self->_select_args(@_);
1366 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1367 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1368 $prepared_bind ||= [];
1371 ? ($sql, $prepared_bind, $bind_attrs)
1372 : \[ "($sql)", @$prepared_bind ]
1377 my ($self, $ident, $select, $where, $attrs) = @_;
1379 my ($alias2source, $root_alias) = $self->_resolve_ident_sources ($ident);
1381 my $sql_maker = $self->sql_maker;
1382 $sql_maker->{_dbic_rs_attrs} = {
1387 _source_handle => $alias2source->{$root_alias}->handle,
1390 # calculate bind_attrs before possible $ident mangling
1391 my $bind_attrs = {};
1392 for my $alias (keys %$alias2source) {
1393 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1394 for my $col (keys %$bindtypes) {
1396 my $fqcn = join ('.', $alias, $col);
1397 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1399 # so that unqualified searches can be bound too
1400 $bind_attrs->{$col} = $bind_attrs->{$fqcn} if $alias eq $root_alias;
1406 $attrs->{software_limit}
1408 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1410 $attrs->{software_limit} = 1;
1413 $self->throw_exception("rows attribute must be positive if present")
1414 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1416 # MySQL actually recommends this approach. I cringe.
1417 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1422 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1423 # otherwise delegate the limiting to the storage, unless software limit was requested
1425 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1427 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1428 $attrs->{prefetch_select} && @{$attrs->{prefetch_select}} )
1430 ($ident, $select, $where, $attrs)
1431 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1433 elsif (! $attrs->{software_limit} ) {
1434 push @limit, $attrs->{rows}, $attrs->{offset};
1438 # This would be the point to deflate anything found in $where
1439 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1440 # expect a row object. And all we have is a resultsource (it is trivial
1441 # to extract deflator coderefs via $alias2source above).
1443 # I don't see a way forward other than changing the way deflators are
1444 # invoked, and that's just bad...
1448 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1449 (qw/order_by group_by having/ )
1452 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1455 sub _adjust_select_args_for_complex_prefetch {
1456 my ($self, $from, $select, $where, $attrs) = @_;
1458 # copies for mangling
1460 $select = [ @$select ];
1461 $attrs = { %$attrs };
1463 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1464 if (ref $from ne 'ARRAY');
1466 # separate attributes
1467 my $sub_attrs = { %$attrs };
1468 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1469 delete $sub_attrs->{$_} for qw/for collapse prefetch_select _collapse_order_by select as/;
1471 my $alias = $attrs->{alias};
1473 # create subquery select list - loop only over primary columns
1474 my $sub_select = [];
1475 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{prefetch_select}} - 1) {
1476 my $sel = $attrs->{select}[$i];
1478 # alias any functions to the dbic-side 'as' label
1479 # adjust the outer select accordingly
1480 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1481 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1482 $select->[$i] = join ('.', $attrs->{alias}, $attrs->{as}[$i]);
1485 push @$sub_select, $sel;
1488 # bring over all non-collapse-induced order_by into the inner query (if any)
1489 # the outer one will have to keep them all
1490 delete $sub_attrs->{order_by};
1491 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1492 $sub_attrs->{order_by} = [
1493 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1498 my $select_root = shift @$from;
1499 my @outer_from = @$from;
1502 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1504 # in complex search_related chains $alias may *not* be 'me'
1505 # so always include it in the inner join, and also shift away
1506 # from the outer stack, so that the two datasets actually do
1508 if ($select_root->{-alias} ne $alias) {
1509 $inner_joins{$alias} = 1;
1511 while (@outer_from && $outer_from[0][0]{-alias} ne $alias) {
1514 if (! @outer_from) {
1515 $self->throw_exception ("Unable to find '$alias' in the {from} stack, something is wrong");
1518 shift @outer_from; # the new subquery will represent this alias, so get rid of it
1522 # decide which parts of the join will remain on the inside
1524 # this is not a very viable optimisation, but it was written
1525 # before I realised this, so might as well remain. We can throw
1526 # away _any_ branches of the join tree that are:
1527 # 1) not mentioned in the condition/order
1528 # 2) left-join leaves (or left-join leaf chains)
1529 # Most of the join conditions will not satisfy this, but for real
1530 # complex queries some might, and we might make some RDBMS happy.
1533 # since we do not have introspectable SQLA, we fall back to ugly
1534 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1535 # in order to determine what goes into %inner_joins
1536 # It may not be very efficient, but it's a reasonable stop-gap
1538 # produce stuff unquoted, so it can be scanned
1539 my $sql_maker = $self->sql_maker;
1540 local $sql_maker->{quote_char};
1543 { ref $_ ? $_->[0] : $_ }
1544 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1547 my $where_sql = $sql_maker->where ($where);
1550 for my $alias (keys %join_info) {
1552 # any table alias found on a column name in where or order_by
1553 # gets included in %inner_joins
1554 # Also any parent joins that are needed to reach this particular alias
1555 for my $piece ($where_sql, @order_by ) {
1556 if ($piece =~ /\b$alias\./) {
1557 $inner_joins{$alias} = 1;
1563 # scan for non-leaf/non-left joins and mark as needed
1564 # also mark all ancestor joins that are needed to reach this particular alias
1565 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1567 # traverse by the size of the -join_path i.e. reverse depth first
1568 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1570 my $j = $join_info{$alias};
1571 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1573 if ($inner_joins{$alias}) {
1574 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1578 # construct the inner $from for the subquery
1579 my $inner_from = [ $select_root ];
1580 for my $j (@$from) {
1581 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1584 # if a multi-type join was needed in the subquery ("multi" is indicated by
1585 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1587 for my $alias (keys %inner_joins) {
1589 # the dot comes from some weirdness in collapse
1590 # remove after the rewrite
1591 if ($attrs->{collapse}{".$alias"}) {
1592 $sub_attrs->{group_by} ||= $sub_select;
1597 # generate the subquery
1598 my $subq = $self->_select_args_to_query (
1605 # put it in the new {from}
1606 unshift @outer_from, {
1608 -source_handle => $select_root->{-source_handle},
1612 # This is totally horrific - the $where ends up in both the inner and outer query
1613 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1614 # then if where conditions apply to the *right* side of the prefetch, you may have
1615 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1616 # the outer select to exclude joins you didin't want in the first place
1618 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1619 return (\@outer_from, $select, $where, $attrs);
1622 sub _resolve_ident_sources {
1623 my ($self, $ident) = @_;
1625 my $alias2source = {};
1628 # the reason this is so contrived is that $ident may be a {from}
1629 # structure, specifying multiple tables to join
1630 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1631 # this is compat mode for insert/update/delete which do not deal with aliases
1632 $alias2source->{me} = $ident;
1635 elsif (ref $ident eq 'ARRAY') {
1639 if (ref $_ eq 'HASH') {
1641 $root_alias = $tabinfo->{-alias};
1643 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1647 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1648 if ($tabinfo->{-source_handle});
1652 return ($alias2source, $root_alias);
1655 # Takes $ident, \@column_names
1657 # returns { $column_name => \%column_info, ... }
1658 # also note: this adds -result_source => $rsrc to the column info
1661 # my $col_sources = $self->_resolve_column_info($ident, [map $_->[0], @{$bind}]);
1662 sub _resolve_column_info {
1663 my ($self, $ident, $colnames) = @_;
1664 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1666 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1669 my (%return, %converted);
1670 foreach my $col (@$colnames) {
1671 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1673 # deal with unqualified cols - we assume the main alias for all
1674 # unqualified ones, ugly but can't think of anything better right now
1675 $alias ||= $root_alias;
1677 my $rsrc = $alias2src->{$alias};
1678 $return{$col} = $rsrc && { %{$rsrc->column_info($colname)}, -result_source => $rsrc };
1683 # Returns a counting SELECT for a simple count
1684 # query. Abstracted so that a storage could override
1685 # this to { count => 'firstcol' } or whatever makes
1686 # sense as a performance optimization
1688 #my ($self, $source, $rs_attrs) = @_;
1689 return { count => '*' };
1692 # Returns a SELECT which will end up in the subselect
1693 # There may or may not be a group_by, as the subquery
1694 # might have been called to accomodate a limit
1696 # Most databases would be happy with whatever ends up
1697 # here, but some choke in various ways.
1699 sub _subq_count_select {
1700 my ($self, $source, $rs_attrs) = @_;
1701 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1703 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1704 return @pcols ? \@pcols : [ 1 ];
1708 sub source_bind_attributes {
1709 my ($self, $source) = @_;
1711 my $bind_attributes;
1712 foreach my $column ($source->columns) {
1714 my $data_type = $source->column_info($column)->{data_type} || '';
1715 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1719 return $bind_attributes;
1726 =item Arguments: $ident, $select, $condition, $attrs
1730 Handle a SQL select statement.
1736 my ($ident, $select, $condition, $attrs) = @_;
1737 return $self->cursor_class->new($self, \@_, $attrs);
1742 my ($rv, $sth, @bind) = $self->_select(@_);
1743 my @row = $sth->fetchrow_array;
1744 my @nextrow = $sth->fetchrow_array if @row;
1745 if(@row && @nextrow) {
1746 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1748 # Need to call finish() to work round broken DBDs
1757 =item Arguments: $sql
1761 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1766 my ($self, $dbh, $sql) = @_;
1768 # 3 is the if_active parameter which avoids active sth re-use
1769 my $sth = $self->disable_sth_caching
1770 ? $dbh->prepare($sql)
1771 : $dbh->prepare_cached($sql, {}, 3);
1773 # XXX You would think RaiseError would make this impossible,
1774 # but apparently that's not true :(
1775 $self->throw_exception($dbh->errstr) if !$sth;
1781 my ($self, $sql) = @_;
1782 $self->dbh_do('_dbh_sth', $sql);
1785 sub _dbh_columns_info_for {
1786 my ($self, $dbh, $table) = @_;
1788 if ($dbh->can('column_info')) {
1791 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1792 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1794 while ( my $info = $sth->fetchrow_hashref() ){
1796 $column_info{data_type} = $info->{TYPE_NAME};
1797 $column_info{size} = $info->{COLUMN_SIZE};
1798 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1799 $column_info{default_value} = $info->{COLUMN_DEF};
1800 my $col_name = $info->{COLUMN_NAME};
1801 $col_name =~ s/^\"(.*)\"$/$1/;
1803 $result{$col_name} = \%column_info;
1806 return \%result if !$@ && scalar keys %result;
1810 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1812 my @columns = @{$sth->{NAME_lc}};
1813 for my $i ( 0 .. $#columns ){
1815 $column_info{data_type} = $sth->{TYPE}->[$i];
1816 $column_info{size} = $sth->{PRECISION}->[$i];
1817 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1819 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1820 $column_info{data_type} = $1;
1821 $column_info{size} = $2;
1824 $result{$columns[$i]} = \%column_info;
1828 foreach my $col (keys %result) {
1829 my $colinfo = $result{$col};
1830 my $type_num = $colinfo->{data_type};
1832 if(defined $type_num && $dbh->can('type_info')) {
1833 my $type_info = $dbh->type_info($type_num);
1834 $type_name = $type_info->{TYPE_NAME} if $type_info;
1835 $colinfo->{data_type} = $type_name if $type_name;
1842 sub columns_info_for {
1843 my ($self, $table) = @_;
1844 $self->dbh_do('_dbh_columns_info_for', $table);
1847 =head2 last_insert_id
1849 Return the row id of the last insert.
1853 sub _dbh_last_insert_id {
1854 # All Storage's need to register their own _dbh_last_insert_id
1855 # the old SQLite-based method was highly inappropriate
1858 my $class = ref $self;
1859 $self->throw_exception (<<EOE);
1861 No _dbh_last_insert_id() method found in $class.
1862 Since the method of obtaining the autoincrement id of the last insert
1863 operation varies greatly between different databases, this method must be
1864 individually implemented for every storage class.
1868 sub last_insert_id {
1870 $self->dbh_do('_dbh_last_insert_id', @_);
1875 Returns the database driver name.
1879 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1881 =head2 bind_attribute_by_data_type
1883 Given a datatype from column info, returns a database specific bind
1884 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1885 let the database planner just handle it.
1887 Generally only needed for special case column types, like bytea in postgres.
1891 sub bind_attribute_by_data_type {
1895 =head2 is_datatype_numeric
1897 Given a datatype from column_info, returns a boolean value indicating if
1898 the current RDBMS considers it a numeric value. This controls how
1899 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1900 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1901 be performed instead of the usual C<eq>.
1905 sub is_datatype_numeric {
1906 my ($self, $dt) = @_;
1908 return 0 unless $dt;
1910 return $dt =~ /^ (?:
1911 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
1916 =head2 create_ddl_dir (EXPERIMENTAL)
1920 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1924 Creates a SQL file based on the Schema, for each of the specified
1925 database engines in C<\@databases> in the given directory.
1926 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1928 Given a previous version number, this will also create a file containing
1929 the ALTER TABLE statements to transform the previous schema into the
1930 current one. Note that these statements may contain C<DROP TABLE> or
1931 C<DROP COLUMN> statements that can potentially destroy data.
1933 The file names are created using the C<ddl_filename> method below, please
1934 override this method in your schema if you would like a different file
1935 name format. For the ALTER file, the same format is used, replacing
1936 $version in the name with "$preversion-$version".
1938 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1939 The most common value for this would be C<< { add_drop_table => 1 } >>
1940 to have the SQL produced include a C<DROP TABLE> statement for each table
1941 created. For quoting purposes supply C<quote_table_names> and
1942 C<quote_field_names>.
1944 If no arguments are passed, then the following default values are assumed:
1948 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1950 =item version - $schema->schema_version
1952 =item directory - './'
1954 =item preversion - <none>
1958 By default, C<\%sqlt_args> will have
1960 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1962 merged with the hash passed in. To disable any of those features, pass in a
1963 hashref like the following
1965 { ignore_constraint_names => 0, # ... other options }
1968 Note that this feature is currently EXPERIMENTAL and may not work correctly
1969 across all databases, or fully handle complex relationships.
1971 WARNING: Please check all SQL files created, before applying them.
1975 sub create_ddl_dir {
1976 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1978 if(!$dir || !-d $dir) {
1979 carp "No directory given, using ./\n";
1982 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1983 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1985 my $schema_version = $schema->schema_version || '1.x';
1986 $version ||= $schema_version;
1989 add_drop_table => 1,
1990 ignore_constraint_names => 1,
1991 ignore_index_names => 1,
1995 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
1996 . $self->_check_sqlt_message . q{'})
1997 if !$self->_check_sqlt_version;
1999 my $sqlt = SQL::Translator->new( $sqltargs );
2001 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2002 my $sqlt_schema = $sqlt->translate({ data => $schema })
2003 or $self->throw_exception ($sqlt->error);
2005 foreach my $db (@$databases) {
2007 $sqlt->{schema} = $sqlt_schema;
2008 $sqlt->producer($db);
2011 my $filename = $schema->ddl_filename($db, $version, $dir);
2012 if (-e $filename && ($version eq $schema_version )) {
2013 # if we are dumping the current version, overwrite the DDL
2014 carp "Overwriting existing DDL file - $filename";
2018 my $output = $sqlt->translate;
2020 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2023 if(!open($file, ">$filename")) {
2024 $self->throw_exception("Can't open $filename for writing ($!)");
2027 print $file $output;
2030 next unless ($preversion);
2032 require SQL::Translator::Diff;
2034 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2035 if(!-e $prefilename) {
2036 carp("No previous schema file found ($prefilename)");
2040 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2042 carp("Overwriting existing diff file - $difffile");
2048 my $t = SQL::Translator->new($sqltargs);
2053 or $self->throw_exception ($t->error);
2055 my $out = $t->translate( $prefilename )
2056 or $self->throw_exception ($t->error);
2058 $source_schema = $t->schema;
2060 $source_schema->name( $prefilename )
2061 unless ( $source_schema->name );
2064 # The "new" style of producers have sane normalization and can support
2065 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2066 # And we have to diff parsed SQL against parsed SQL.
2067 my $dest_schema = $sqlt_schema;
2069 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2070 my $t = SQL::Translator->new($sqltargs);
2075 or $self->throw_exception ($t->error);
2077 my $out = $t->translate( $filename )
2078 or $self->throw_exception ($t->error);
2080 $dest_schema = $t->schema;
2082 $dest_schema->name( $filename )
2083 unless $dest_schema->name;
2086 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2090 if(!open $file, ">$difffile") {
2091 $self->throw_exception("Can't write to $difffile ($!)");
2099 =head2 deployment_statements
2103 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2107 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2109 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2110 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2112 C<$directory> is used to return statements from files in a previously created
2113 L</create_ddl_dir> directory and is optional. The filenames are constructed
2114 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2116 If no C<$directory> is specified then the statements are constructed on the
2117 fly using L<SQL::Translator> and C<$version> is ignored.
2119 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2123 sub deployment_statements {
2124 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2125 # Need to be connected to get the correct sqlt_type
2126 $self->ensure_connected() unless $type;
2127 $type ||= $self->sqlt_type;
2128 $version ||= $schema->schema_version || '1.x';
2130 my $filename = $schema->ddl_filename($type, $version, $dir);
2134 open($file, "<$filename")
2135 or $self->throw_exception("Can't open $filename ($!)");
2138 return join('', @rows);
2141 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2142 . $self->_check_sqlt_message . q{'})
2143 if !$self->_check_sqlt_version;
2145 require SQL::Translator::Parser::DBIx::Class;
2146 eval qq{use SQL::Translator::Producer::${type}};
2147 $self->throw_exception($@) if $@;
2149 # sources needs to be a parser arg, but for simplicty allow at top level
2151 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2152 if exists $sqltargs->{sources};
2154 my $tr = SQL::Translator->new(%$sqltargs);
2155 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2156 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2160 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2163 return if($line =~ /^--/);
2165 # next if($line =~ /^DROP/m);
2166 return if($line =~ /^BEGIN TRANSACTION/m);
2167 return if($line =~ /^COMMIT/m);
2168 return if $line =~ /^\s+$/; # skip whitespace only
2169 $self->_query_start($line);
2171 $self->dbh->do($line); # shouldn't be using ->dbh ?
2174 carp qq{$@ (running "${line}")};
2176 $self->_query_end($line);
2178 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2179 if (@statements > 1) {
2180 foreach my $statement (@statements) {
2181 $deploy->( $statement );
2184 elsif (@statements == 1) {
2185 foreach my $line ( split(";\n", $statements[0])) {
2191 =head2 datetime_parser
2193 Returns the datetime parser class
2197 sub datetime_parser {
2199 return $self->{datetime_parser} ||= do {
2200 $self->ensure_connected;
2201 $self->build_datetime_parser(@_);
2205 =head2 datetime_parser_type
2207 Defines (returns) the datetime parser class - currently hardwired to
2208 L<DateTime::Format::MySQL>
2212 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2214 =head2 build_datetime_parser
2216 See L</datetime_parser>
2220 sub build_datetime_parser {
2222 my $type = $self->datetime_parser_type(@_);
2224 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2229 my $_check_sqlt_version; # private
2230 my $_check_sqlt_message; # private
2231 sub _check_sqlt_version {
2232 return $_check_sqlt_version if defined $_check_sqlt_version;
2233 eval 'use SQL::Translator "0.09003"';
2234 $_check_sqlt_message = $@ || '';
2235 $_check_sqlt_version = !$@;
2238 sub _check_sqlt_message {
2239 _check_sqlt_version if !defined $_check_sqlt_message;
2240 $_check_sqlt_message;
2244 =head2 is_replicating
2246 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2247 replicate from a master database. Default is undef, which is the result
2248 returned by databases that don't support replication.
2252 sub is_replicating {
2257 =head2 lag_behind_master
2259 Returns a number that represents a certain amount of lag behind a master db
2260 when a given storage is replicating. The number is database dependent, but
2261 starts at zero and increases with the amount of lag. Default in undef
2265 sub lag_behind_master {
2271 return if !$self->_dbh;
2280 =head2 DBIx::Class and AutoCommit
2282 DBIx::Class can do some wonderful magic with handling exceptions,
2283 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2284 combined with C<txn_do> for transaction support.
2286 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2287 in an assumed transaction between commits, and you're telling us you'd
2288 like to manage that manually. A lot of the magic protections offered by
2289 this module will go away. We can't protect you from exceptions due to database
2290 disconnects because we don't know anything about how to restart your
2291 transactions. You're on your own for handling all sorts of exceptional
2292 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2299 Matt S. Trout <mst@shadowcatsystems.co.uk>
2301 Andy Grundman <andy@hybridized.org>
2305 You may distribute this code under the same terms as Perl itself.