1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
7 use base qw/DBIx::Class::Storage::DBIHacks DBIx::Class::Storage/;
10 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use DBIx::Class::Storage::Statistics;
16 use Data::Dumper::Concise();
21 __PACKAGE__->mk_group_accessors('simple' =>
22 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
23 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints
27 # the values for these accessors are picked out (and deleted) from
28 # the attribute hashref passed to connect_info
29 my @storage_options = qw/
30 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
31 disable_sth_caching unsafe auto_savepoint
33 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
36 # default cursor class, overridable in connect_info attributes
37 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
39 __PACKAGE__->mk_group_accessors('inherited' => qw/
41 _supports_insert_returning
43 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
45 # Each of these methods need _determine_driver called before itself
46 # in order to function reliably. This is a purely DRY optimization
47 my @rdbms_specific_methods = qw/
62 for my $meth (@rdbms_specific_methods) {
64 my $orig = __PACKAGE__->can ($meth)
68 no warnings qw/redefine/;
69 *{__PACKAGE__ ."::$meth"} = Sub::Name::subname $meth => sub {
70 if (not $_[0]->_driver_determined) {
71 $_[0]->_determine_driver;
72 goto $_[0]->can($meth);
81 DBIx::Class::Storage::DBI - DBI storage handler
85 my $schema = MySchema->connect('dbi:SQLite:my.db');
87 $schema->storage->debug(1);
89 my @stuff = $schema->storage->dbh_do(
91 my ($storage, $dbh, @args) = @_;
92 $dbh->do("DROP TABLE authors");
97 $schema->resultset('Book')->search({
98 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
103 This class represents the connection to an RDBMS via L<DBI>. See
104 L<DBIx::Class::Storage> for general information. This pod only
105 documents DBI-specific methods and behaviors.
112 my $new = shift->next::method(@_);
114 $new->transaction_depth(0);
115 $new->_sql_maker_opts({});
116 $new->{savepoints} = [];
117 $new->{_in_dbh_do} = 0;
118 $new->{_dbh_gen} = 0;
120 # read below to see what this does
121 $new->_arm_global_destructor;
126 # This is hack to work around perl shooting stuff in random
127 # order on exit(). If we do not walk the remaining storage
128 # objects in an END block, there is a *small but real* chance
129 # of a fork()ed child to kill the parent's shared DBI handle,
130 # *before perl reaches the DESTROY in this package*
131 # Yes, it is ugly and effective.
133 my %seek_and_destroy;
135 sub _arm_global_destructor {
137 my $key = Scalar::Util::refaddr ($self);
138 $seek_and_destroy{$key} = $self;
139 Scalar::Util::weaken ($seek_and_destroy{$key});
143 local $?; # just in case the DBI destructor changes it somehow
145 # destroy just the object if not native to this process/thread
146 $_->_preserve_foreign_dbh for (grep
148 values %seek_and_destroy
156 # destroy just the object if not native to this process/thread
157 $self->_preserve_foreign_dbh;
159 # some databases need this to stop spewing warnings
160 if (my $dbh = $self->_dbh) {
162 %{ $dbh->{CachedKids} } = ();
170 sub _preserve_foreign_dbh {
173 return unless $self->_dbh;
177 return unless $self->_dbh;
183 # handle pid changes correctly - do not destroy parent's connection
187 return if ( defined $self->_conn_pid and $self->_conn_pid == $$ );
189 $self->_dbh->{InactiveDestroy} = 1;
196 # very similar to above, but seems to FAIL if I set InactiveDestroy
200 if ( ! defined $self->_conn_tid ) {
203 elsif ( $self->_conn_tid == threads->tid ) {
204 return; # same thread
207 #$self->_dbh->{InactiveDestroy} = 1; # why does t/51threads.t fail...?
217 This method is normally called by L<DBIx::Class::Schema/connection>, which
218 encapsulates its argument list in an arrayref before passing them here.
220 The argument list may contain:
226 The same 4-element argument set one would normally pass to
227 L<DBI/connect>, optionally followed by
228 L<extra attributes|/DBIx::Class specific connection attributes>
229 recognized by DBIx::Class:
231 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
235 A single code reference which returns a connected
236 L<DBI database handle|DBI/connect> optionally followed by
237 L<extra attributes|/DBIx::Class specific connection attributes> recognized
240 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
244 A single hashref with all the attributes and the dsn/user/password
247 $connect_info_args = [{
255 $connect_info_args = [{
256 dbh_maker => sub { DBI->connect (...) },
261 This is particularly useful for L<Catalyst> based applications, allowing the
262 following config (L<Config::General> style):
267 dsn dbi:mysql:database=test
274 The C<dsn>/C<user>/C<password> combination can be substituted by the
275 C<dbh_maker> key whose value is a coderef that returns a connected
276 L<DBI database handle|DBI/connect>
280 Please note that the L<DBI> docs recommend that you always explicitly
281 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
282 recommends that it be set to I<1>, and that you perform transactions
283 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
284 to I<1> if you do not do explicitly set it to zero. This is the default
285 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
287 =head3 DBIx::Class specific connection attributes
289 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
290 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
291 the following connection options. These options can be mixed in with your other
292 L<DBI> connection attributes, or placed in a separate hashref
293 (C<\%extra_attributes>) as shown above.
295 Every time C<connect_info> is invoked, any previous settings for
296 these options will be cleared before setting the new ones, regardless of
297 whether any options are specified in the new C<connect_info>.
304 Specifies things to do immediately after connecting or re-connecting to
305 the database. Its value may contain:
311 This contains one SQL statement to execute.
313 =item an array reference
315 This contains SQL statements to execute in order. Each element contains
316 a string or a code reference that returns a string.
318 =item a code reference
320 This contains some code to execute. Unlike code references within an
321 array reference, its return value is ignored.
325 =item on_disconnect_do
327 Takes arguments in the same form as L</on_connect_do> and executes them
328 immediately before disconnecting from the database.
330 Note, this only runs if you explicitly call L</disconnect> on the
333 =item on_connect_call
335 A more generalized form of L</on_connect_do> that calls the specified
336 C<connect_call_METHOD> methods in your storage driver.
338 on_connect_do => 'select 1'
342 on_connect_call => [ [ do_sql => 'select 1' ] ]
344 Its values may contain:
350 Will call the C<connect_call_METHOD> method.
352 =item a code reference
354 Will execute C<< $code->($storage) >>
356 =item an array reference
358 Each value can be a method name or code reference.
360 =item an array of arrays
362 For each array, the first item is taken to be the C<connect_call_> method name
363 or code reference, and the rest are parameters to it.
367 Some predefined storage methods you may use:
373 Executes a SQL string or a code reference that returns a SQL string. This is
374 what L</on_connect_do> and L</on_disconnect_do> use.
382 Will execute the scalar as SQL.
386 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
387 attributes hashref and bind values.
389 =item a code reference
391 Will execute C<< $code->($storage) >> and execute the return array refs as
398 Execute any statements necessary to initialize the database session to return
399 and accept datetime/timestamp values used with
400 L<DBIx::Class::InflateColumn::DateTime>.
402 Only necessary for some databases, see your specific storage driver for
403 implementation details.
407 =item on_disconnect_call
409 Takes arguments in the same form as L</on_connect_call> and executes them
410 immediately before disconnecting from the database.
412 Calls the C<disconnect_call_METHOD> methods as opposed to the
413 C<connect_call_METHOD> methods called by L</on_connect_call>.
415 Note, this only runs if you explicitly call L</disconnect> on the
418 =item disable_sth_caching
420 If set to a true value, this option will disable the caching of
421 statement handles via L<DBI/prepare_cached>.
425 Sets the limit dialect. This is useful for JDBC-bridge among others
426 where the remote SQL-dialect cannot be determined by the name of the
427 driver alone. See also L<SQL::Abstract::Limit>.
431 Specifies what characters to use to quote table and column names. If
432 you use this you will want to specify L</name_sep> as well.
434 C<quote_char> expects either a single character, in which case is it
435 is placed on either side of the table/column name, or an arrayref of length
436 2 in which case the table/column name is placed between the elements.
438 For example under MySQL you should use C<< quote_char => '`' >>, and for
439 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
443 This only needs to be used in conjunction with C<quote_char>, and is used to
444 specify the character that separates elements (schemas, tables, columns) from
445 each other. In most cases this is simply a C<.>.
447 The consequences of not supplying this value is that L<SQL::Abstract>
448 will assume DBIx::Class' uses of aliases to be complete column
449 names. The output will look like I<"me.name"> when it should actually
454 This Storage driver normally installs its own C<HandleError>, sets
455 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
456 all database handles, including those supplied by a coderef. It does this
457 so that it can have consistent and useful error behavior.
459 If you set this option to a true value, Storage will not do its usual
460 modifications to the database handle's attributes, and instead relies on
461 the settings in your connect_info DBI options (or the values you set in
462 your connection coderef, in the case that you are connecting via coderef).
464 Note that your custom settings can cause Storage to malfunction,
465 especially if you set a C<HandleError> handler that suppresses exceptions
466 and/or disable C<RaiseError>.
470 If this option is true, L<DBIx::Class> will use savepoints when nesting
471 transactions, making it possible to recover from failure in the inner
472 transaction without having to abort all outer transactions.
476 Use this argument to supply a cursor class other than the default
477 L<DBIx::Class::Storage::DBI::Cursor>.
481 Some real-life examples of arguments to L</connect_info> and
482 L<DBIx::Class::Schema/connect>
484 # Simple SQLite connection
485 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
488 ->connect_info([ sub { DBI->connect(...) } ]);
490 # Connect via subref in hashref
492 dbh_maker => sub { DBI->connect(...) },
493 on_connect_do => 'alter session ...',
496 # A bit more complicated
503 { quote_char => q{"}, name_sep => q{.} },
507 # Equivalent to the previous example
513 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
517 # Same, but with hashref as argument
518 # See parse_connect_info for explanation
521 dsn => 'dbi:Pg:dbname=foo',
523 password => 'my_pg_password',
530 # Subref + DBIx::Class-specific connection options
533 sub { DBI->connect(...) },
537 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
538 disable_sth_caching => 1,
548 my ($self, $info) = @_;
550 return $self->_connect_info if !$info;
552 $self->_connect_info($info); # copy for _connect_info
554 $info = $self->_normalize_connect_info($info)
555 if ref $info eq 'ARRAY';
557 for my $storage_opt (keys %{ $info->{storage_options} }) {
558 my $value = $info->{storage_options}{$storage_opt};
560 $self->$storage_opt($value);
563 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
564 # the new set of options
565 $self->_sql_maker(undef);
566 $self->_sql_maker_opts({});
568 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
569 my $value = $info->{sql_maker_options}{$sql_maker_opt};
571 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
575 %{ $self->_default_dbi_connect_attributes || {} },
576 %{ $info->{attributes} || {} },
579 my @args = @{ $info->{arguments} };
581 $self->_dbi_connect_info([@args,
582 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
584 return $self->_connect_info;
587 sub _normalize_connect_info {
588 my ($self, $info_arg) = @_;
591 my @args = @$info_arg; # take a shallow copy for further mutilation
593 # combine/pre-parse arguments depending on invocation style
596 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
597 %attrs = %{ $args[1] || {} };
600 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
601 %attrs = %{$args[0]};
603 if (my $code = delete $attrs{dbh_maker}) {
606 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
609 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
610 . "to the result of 'dbh_maker'",
612 join (', ', map { "'$_'" } (@ignored) ),
617 @args = delete @attrs{qw/dsn user password/};
620 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
622 % { $args[3] || {} },
623 % { $args[4] || {} },
625 @args = @args[0,1,2];
628 $info{arguments} = \@args;
630 my @storage_opts = grep exists $attrs{$_},
631 @storage_options, 'cursor_class';
633 @{ $info{storage_options} }{@storage_opts} =
634 delete @attrs{@storage_opts} if @storage_opts;
636 my @sql_maker_opts = grep exists $attrs{$_},
637 qw/limit_dialect quote_char name_sep/;
639 @{ $info{sql_maker_options} }{@sql_maker_opts} =
640 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
642 $info{attributes} = \%attrs if %attrs;
647 sub _default_dbi_connect_attributes {
657 This method is deprecated in favour of setting via L</connect_info>.
661 =head2 on_disconnect_do
663 This method is deprecated in favour of setting via L</connect_info>.
667 sub _parse_connect_do {
668 my ($self, $type) = @_;
670 my $val = $self->$type;
671 return () if not defined $val;
676 push @res, [ 'do_sql', $val ];
677 } elsif (ref($val) eq 'CODE') {
679 } elsif (ref($val) eq 'ARRAY') {
680 push @res, map { [ 'do_sql', $_ ] } @$val;
682 $self->throw_exception("Invalid type for $type: ".ref($val));
690 Arguments: ($subref | $method_name), @extra_coderef_args?
692 Execute the given $subref or $method_name using the new exception-based
693 connection management.
695 The first two arguments will be the storage object that C<dbh_do> was called
696 on and a database handle to use. Any additional arguments will be passed
697 verbatim to the called subref as arguments 2 and onwards.
699 Using this (instead of $self->_dbh or $self->dbh) ensures correct
700 exception handling and reconnection (or failover in future subclasses).
702 Your subref should have no side-effects outside of the database, as
703 there is the potential for your subref to be partially double-executed
704 if the database connection was stale/dysfunctional.
708 my @stuff = $schema->storage->dbh_do(
710 my ($storage, $dbh, @cols) = @_;
711 my $cols = join(q{, }, @cols);
712 $dbh->selectrow_array("SELECT $cols FROM foo");
723 my $dbh = $self->_get_dbh;
725 return $self->$code($dbh, @_)
726 if ( $self->{_in_dbh_do} || $self->{transaction_depth} );
728 local $self->{_in_dbh_do} = 1;
732 return $self->$code ($dbh, @args);
734 $self->throw_exception($_) if $self->connected;
736 # We were not connected - reconnect and retry, but let any
737 # exception fall right through this time
738 carp "Retrying $code after catching disconnected exception: $_"
739 if $ENV{DBIC_DBIRETRY_DEBUG};
741 $self->_populate_dbh;
742 $self->$code($self->_dbh, @args);
746 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
747 # It also informs dbh_do to bypass itself while under the direction of txn_do,
748 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
753 ref $coderef eq 'CODE' or $self->throw_exception
754 ('$coderef must be a CODE reference');
756 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
758 local $self->{_in_dbh_do} = 1;
761 my $want_array = wantarray;
772 @result = $coderef->(@args);
774 elsif(defined $want_array) {
775 $result[0] = $coderef->(@args);
785 if(! defined $exception) { return $want_array ? @result : $result[0] }
787 if($tried++ || $self->connected) {
788 my $rollback_exception;
789 try { $self->txn_rollback } catch { $rollback_exception = shift };
790 if(defined $rollback_exception) {
791 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
792 $self->throw_exception($exception) # propagate nested rollback
793 if $rollback_exception =~ /$exception_class/;
795 $self->throw_exception(
796 "Transaction aborted: ${exception}. "
797 . "Rollback failed: ${rollback_exception}"
800 $self->throw_exception($exception)
803 # We were not connected, and was first try - reconnect and retry
805 carp "Retrying $coderef after catching disconnected exception: $exception"
806 if $ENV{DBIC_DBIRETRY_DEBUG};
807 $self->_populate_dbh;
813 Our C<disconnect> method also performs a rollback first if the
814 database is not in C<AutoCommit> mode.
824 push @actions, ( $self->on_disconnect_call || () );
825 push @actions, $self->_parse_connect_do ('on_disconnect_do');
827 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
829 $self->_dbh_rollback unless $self->_dbh_autocommit;
831 %{ $self->_dbh->{CachedKids} } = ();
832 $self->_dbh->disconnect;
838 =head2 with_deferred_fk_checks
842 =item Arguments: C<$coderef>
844 =item Return Value: The return value of $coderef
848 Storage specific method to run the code ref with FK checks deferred or
849 in MySQL's case disabled entirely.
853 # Storage subclasses should override this
854 sub with_deferred_fk_checks {
855 my ($self, $sub) = @_;
863 =item Arguments: none
865 =item Return Value: 1|0
869 Verifies that the current database handle is active and ready to execute
870 an SQL statement (e.g. the connection did not get stale, server is still
871 answering, etc.) This method is used internally by L</dbh>.
877 return 0 unless $self->_seems_connected;
880 local $self->_dbh->{RaiseError} = 1;
885 sub _seems_connected {
888 $self->_preserve_foreign_dbh;
890 my $dbh = $self->_dbh
893 return $dbh->FETCH('Active');
899 my $dbh = $self->_dbh or return 0;
904 sub ensure_connected {
907 unless ($self->connected) {
908 $self->_populate_dbh;
914 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
915 is guaranteed to be healthy by implicitly calling L</connected>, and if
916 necessary performing a reconnection before returning. Keep in mind that this
917 is very B<expensive> on some database engines. Consider using L</dbh_do>
925 if (not $self->_dbh) {
926 $self->_populate_dbh;
928 $self->ensure_connected;
933 # this is the internal "get dbh or connect (don't check)" method
936 $self->_preserve_foreign_dbh;
937 $self->_populate_dbh unless $self->_dbh;
941 sub _sql_maker_args {
946 array_datatypes => 1,
947 limit_dialect => $self->_get_dbh,
948 %{$self->_sql_maker_opts}
954 unless ($self->_sql_maker) {
955 my $sql_maker_class = $self->sql_maker_class;
956 $self->ensure_class_loaded ($sql_maker_class);
957 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
959 return $self->_sql_maker;
962 # nothing to do by default
969 my @info = @{$self->_dbi_connect_info || []};
970 $self->_dbh(undef); # in case ->connected failed we might get sent here
971 $self->_server_info_hash (undef);
972 $self->_dbh($self->_connect(@info));
974 $self->_conn_pid($$);
975 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
977 $self->_determine_driver;
979 # Always set the transaction depth on connect, since
980 # there is no transaction in progress by definition
981 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
983 $self->_run_connection_actions unless $self->{_in_determine_driver};
986 sub _run_connection_actions {
990 push @actions, ( $self->on_connect_call || () );
991 push @actions, $self->_parse_connect_do ('on_connect_do');
993 $self->_do_connection_actions(connect_call_ => $_) for @actions;
999 unless ($self->_server_info_hash) {
1003 my $server_version = try { $self->_get_server_version };
1005 if (defined $server_version) {
1006 $info{dbms_version} = $server_version;
1008 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1009 my @verparts = split (/\./, $numeric_version);
1015 # consider only up to 3 version parts, iff not more than 3 digits
1017 while (@verparts && @use_parts < 3) {
1018 my $p = shift @verparts;
1020 push @use_parts, $p;
1022 push @use_parts, 0 while @use_parts < 3;
1024 $info{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1028 $self->_server_info_hash(\%info);
1031 return $self->_server_info_hash
1034 sub _get_server_version {
1035 shift->_get_dbh->get_info(18);
1038 sub _determine_driver {
1041 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1042 my $started_connected = 0;
1043 local $self->{_in_determine_driver} = 1;
1045 if (ref($self) eq __PACKAGE__) {
1047 if ($self->_dbh) { # we are connected
1048 $driver = $self->_dbh->{Driver}{Name};
1049 $started_connected = 1;
1051 # if connect_info is a CODEREF, we have no choice but to connect
1052 if (ref $self->_dbi_connect_info->[0] &&
1053 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
1054 $self->_populate_dbh;
1055 $driver = $self->_dbh->{Driver}{Name};
1058 # try to use dsn to not require being connected, the driver may still
1059 # force a connection in _rebless to determine version
1060 # (dsn may not be supplied at all if all we do is make a mock-schema)
1061 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1062 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1063 $driver ||= $ENV{DBI_DRIVER};
1068 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1069 if ($self->load_optional_class($storage_class)) {
1070 mro::set_mro($storage_class, 'c3');
1071 bless $self, $storage_class;
1077 $self->_driver_determined(1);
1079 $self->_init; # run driver-specific initializations
1081 $self->_run_connection_actions
1082 if !$started_connected && defined $self->_dbh;
1086 sub _do_connection_actions {
1088 my $method_prefix = shift;
1091 if (not ref($call)) {
1092 my $method = $method_prefix . $call;
1094 } elsif (ref($call) eq 'CODE') {
1096 } elsif (ref($call) eq 'ARRAY') {
1097 if (ref($call->[0]) ne 'ARRAY') {
1098 $self->_do_connection_actions($method_prefix, $_) for @$call;
1100 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1103 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1109 sub connect_call_do_sql {
1111 $self->_do_query(@_);
1114 sub disconnect_call_do_sql {
1116 $self->_do_query(@_);
1119 # override in db-specific backend when necessary
1120 sub connect_call_datetime_setup { 1 }
1123 my ($self, $action) = @_;
1125 if (ref $action eq 'CODE') {
1126 $action = $action->($self);
1127 $self->_do_query($_) foreach @$action;
1130 # Most debuggers expect ($sql, @bind), so we need to exclude
1131 # the attribute hash which is the second argument to $dbh->do
1132 # furthermore the bind values are usually to be presented
1133 # as named arrayref pairs, so wrap those here too
1134 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1135 my $sql = shift @do_args;
1136 my $attrs = shift @do_args;
1137 my @bind = map { [ undef, $_ ] } @do_args;
1139 $self->_query_start($sql, @bind);
1140 $self->_get_dbh->do($sql, $attrs, @do_args);
1141 $self->_query_end($sql, @bind);
1148 my ($self, @info) = @_;
1150 $self->throw_exception("You failed to provide any connection info")
1153 my ($old_connect_via, $dbh);
1155 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1156 $old_connect_via = $DBI::connect_via;
1157 $DBI::connect_via = 'connect';
1161 if(ref $info[0] eq 'CODE') {
1162 $dbh = $info[0]->();
1165 $dbh = DBI->connect(@info);
1172 unless ($self->unsafe) {
1173 my $weak_self = $self;
1174 Scalar::Util::weaken($weak_self);
1175 $dbh->{HandleError} = sub {
1177 $weak_self->throw_exception("DBI Exception: $_[0]");
1180 # the handler may be invoked by something totally out of
1182 croak ("DBI Exception: $_[0]");
1185 $dbh->{ShowErrorStatement} = 1;
1186 $dbh->{RaiseError} = 1;
1187 $dbh->{PrintError} = 0;
1191 $self->throw_exception("DBI Connection failed: $_")
1194 $DBI::connect_via = $old_connect_via if $old_connect_via;
1197 $self->_dbh_autocommit($dbh->{AutoCommit});
1202 my ($self, $name) = @_;
1204 $name = $self->_svp_generate_name
1205 unless defined $name;
1207 $self->throw_exception ("You can't use savepoints outside a transaction")
1208 if $self->{transaction_depth} == 0;
1210 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1211 unless $self->can('_svp_begin');
1213 push @{ $self->{savepoints} }, $name;
1215 $self->debugobj->svp_begin($name) if $self->debug;
1217 return $self->_svp_begin($name);
1221 my ($self, $name) = @_;
1223 $self->throw_exception ("You can't use savepoints outside a transaction")
1224 if $self->{transaction_depth} == 0;
1226 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1227 unless $self->can('_svp_release');
1229 if (defined $name) {
1230 $self->throw_exception ("Savepoint '$name' does not exist")
1231 unless grep { $_ eq $name } @{ $self->{savepoints} };
1233 # Dig through the stack until we find the one we are releasing. This keeps
1234 # the stack up to date.
1237 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1239 $name = pop @{ $self->{savepoints} };
1242 $self->debugobj->svp_release($name) if $self->debug;
1244 return $self->_svp_release($name);
1248 my ($self, $name) = @_;
1250 $self->throw_exception ("You can't use savepoints outside a transaction")
1251 if $self->{transaction_depth} == 0;
1253 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1254 unless $self->can('_svp_rollback');
1256 if (defined $name) {
1257 # If they passed us a name, verify that it exists in the stack
1258 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1259 $self->throw_exception("Savepoint '$name' does not exist!");
1262 # Dig through the stack until we find the one we are releasing. This keeps
1263 # the stack up to date.
1264 while(my $s = pop(@{ $self->{savepoints} })) {
1265 last if($s eq $name);
1267 # Add the savepoint back to the stack, as a rollback doesn't remove the
1268 # named savepoint, only everything after it.
1269 push(@{ $self->{savepoints} }, $name);
1271 # We'll assume they want to rollback to the last savepoint
1272 $name = $self->{savepoints}->[-1];
1275 $self->debugobj->svp_rollback($name) if $self->debug;
1277 return $self->_svp_rollback($name);
1280 sub _svp_generate_name {
1283 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1289 # this means we have not yet connected and do not know the AC status
1290 # (e.g. coderef $dbh)
1291 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1293 if($self->{transaction_depth} == 0) {
1294 $self->debugobj->txn_begin()
1296 $self->_dbh_begin_work;
1298 elsif ($self->auto_savepoint) {
1301 $self->{transaction_depth}++;
1304 sub _dbh_begin_work {
1307 # if the user is utilizing txn_do - good for him, otherwise we need to
1308 # ensure that the $dbh is healthy on BEGIN.
1309 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1310 # will be replaced by a failure of begin_work itself (which will be
1311 # then retried on reconnect)
1312 if ($self->{_in_dbh_do}) {
1313 $self->_dbh->begin_work;
1315 $self->dbh_do(sub { $_[1]->begin_work });
1321 if ($self->{transaction_depth} == 1) {
1322 $self->debugobj->txn_commit()
1325 $self->{transaction_depth} = 0
1326 if $self->_dbh_autocommit;
1328 elsif($self->{transaction_depth} > 1) {
1329 $self->{transaction_depth}--;
1331 if $self->auto_savepoint;
1337 my $dbh = $self->_dbh
1338 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1344 my $dbh = $self->_dbh;
1346 if ($self->{transaction_depth} == 1) {
1347 $self->debugobj->txn_rollback()
1349 $self->{transaction_depth} = 0
1350 if $self->_dbh_autocommit;
1351 $self->_dbh_rollback;
1353 elsif($self->{transaction_depth} > 1) {
1354 $self->{transaction_depth}--;
1355 if ($self->auto_savepoint) {
1356 $self->svp_rollback;
1361 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1365 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1367 if ($_ !~ /$exception_class/) {
1368 # ensure that a failed rollback resets the transaction depth
1369 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1372 $self->throw_exception($_)
1378 my $dbh = $self->_dbh
1379 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1383 # This used to be the top-half of _execute. It was split out to make it
1384 # easier to override in NoBindVars without duping the rest. It takes up
1385 # all of _execute's args, and emits $sql, @bind.
1386 sub _prep_for_execute {
1387 my ($self, $op, $extra_bind, $ident, $args) = @_;
1389 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1390 $ident = $ident->from();
1393 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1396 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1398 return ($sql, \@bind);
1402 sub _fix_bind_params {
1403 my ($self, @bind) = @_;
1405 ### Turn @bind from something like this:
1406 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1408 ### ( "'1'", "'1'", "'3'" )
1411 if ( defined( $_ && $_->[1] ) ) {
1412 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1419 my ( $self, $sql, @bind ) = @_;
1421 if ( $self->debug ) {
1422 @bind = $self->_fix_bind_params(@bind);
1424 $self->debugobj->query_start( $sql, @bind );
1429 my ( $self, $sql, @bind ) = @_;
1431 if ( $self->debug ) {
1432 @bind = $self->_fix_bind_params(@bind);
1433 $self->debugobj->query_end( $sql, @bind );
1438 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1440 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1442 $self->_query_start( $sql, @$bind );
1444 my $sth = $self->sth($sql,$op);
1446 my $placeholder_index = 1;
1448 foreach my $bound (@$bind) {
1449 my $attributes = {};
1450 my($column_name, @data) = @$bound;
1452 if ($bind_attributes) {
1453 $attributes = $bind_attributes->{$column_name}
1454 if defined $bind_attributes->{$column_name};
1457 foreach my $data (@data) {
1458 my $ref = ref $data;
1459 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1461 $sth->bind_param($placeholder_index, $data, $attributes);
1462 $placeholder_index++;
1466 # Can this fail without throwing an exception anyways???
1467 my $rv = $sth->execute();
1468 $self->throw_exception($sth->errstr) if !$rv;
1470 $self->_query_end( $sql, @$bind );
1472 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1477 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1480 sub _prefetch_insert_auto_nextvals {
1481 my ($self, $source, $to_insert) = @_;
1485 foreach my $col ( $source->columns ) {
1486 if ( !defined $to_insert->{$col} ) {
1487 my $col_info = $source->column_info($col);
1489 if ( $col_info->{auto_nextval} ) {
1490 $upd->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1492 $col_info->{sequence} ||=
1493 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1504 my ($source, $to_insert, $opts) = @_;
1506 my $updated_cols = $self->_prefetch_insert_auto_nextvals (@_);
1508 my $bind_attributes = $self->source_bind_attributes($source);
1510 my ($rv, $sth) = $self->_execute('insert' => [], $source, $bind_attributes, $to_insert, $opts);
1512 if ($opts->{returning}) {
1513 my @ret_cols = @{$opts->{returning}};
1515 my @ret_vals = try {
1516 local $SIG{__WARN__} = sub {};
1517 my @r = $sth->fetchrow_array;
1523 @ret{@ret_cols} = @ret_vals if (@ret_vals);
1531 return $updated_cols;
1534 ## Currently it is assumed that all values passed will be "normal", i.e. not
1535 ## scalar refs, or at least, all the same type as the first set, the statement is
1536 ## only prepped once.
1538 my ($self, $source, $cols, $data) = @_;
1541 @colvalues{@$cols} = (0..$#$cols);
1543 for my $i (0..$#$cols) {
1544 my $first_val = $data->[0][$i];
1545 next unless ref $first_val eq 'SCALAR';
1547 $colvalues{ $cols->[$i] } = $first_val;
1550 # check for bad data and stringify stringifiable objects
1551 my $bad_slice = sub {
1552 my ($msg, $col_idx, $slice_idx) = @_;
1553 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1557 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1558 Data::Dumper::Concise::Dumper({
1559 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1565 for my $datum_idx (0..$#$data) {
1566 my $datum = $data->[$datum_idx];
1568 for my $col_idx (0..$#$cols) {
1569 my $val = $datum->[$col_idx];
1570 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1571 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1573 if ($is_literal_sql) {
1575 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1577 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1578 $bad_slice->("$reftype reference found where literal SQL expected",
1579 $col_idx, $datum_idx);
1581 elsif ($$val ne $$sqla_bind){
1582 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1583 $col_idx, $datum_idx);
1586 elsif (my $reftype = ref $val) {
1588 if (overload::Method($val, '""')) {
1589 $datum->[$col_idx] = "".$val;
1592 $bad_slice->("$reftype reference found where bind expected",
1593 $col_idx, $datum_idx);
1599 my ($sql, $bind) = $self->_prep_for_execute (
1600 'insert', undef, $source, [\%colvalues]
1604 my $empty_bind = 1 if (not @bind) &&
1605 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1607 if ((not @bind) && (not $empty_bind)) {
1608 $self->throw_exception(
1609 'Cannot insert_bulk without support for placeholders'
1613 # neither _execute_array, nor _execute_inserts_with_no_binds are
1614 # atomic (even if _execute _array is a single call). Thus a safety
1616 my $guard = $self->txn_scope_guard;
1618 $self->_query_start( $sql, ['__BULK__'] );
1619 my $sth = $self->sth($sql);
1622 # bind_param_array doesn't work if there are no binds
1623 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1626 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1627 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1631 $self->_query_end( $sql, ['__BULK__'] );
1635 return (wantarray ? ($rv, $sth, @bind) : $rv);
1638 sub _execute_array {
1639 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1641 ## This must be an arrayref, else nothing works!
1642 my $tuple_status = [];
1644 ## Get the bind_attributes, if any exist
1645 my $bind_attributes = $self->source_bind_attributes($source);
1647 ## Bind the values and execute
1648 my $placeholder_index = 1;
1650 foreach my $bound (@$bind) {
1652 my $attributes = {};
1653 my ($column_name, $data_index) = @$bound;
1655 if( $bind_attributes ) {
1656 $attributes = $bind_attributes->{$column_name}
1657 if defined $bind_attributes->{$column_name};
1660 my @data = map { $_->[$data_index] } @$data;
1662 $sth->bind_param_array(
1665 (%$attributes ? $attributes : ()),
1667 $placeholder_index++;
1672 $rv = $self->_dbh_execute_array($sth, $tuple_status, @extra);
1678 # Statement must finish even if there was an exception.
1683 $err = shift unless defined $err
1688 if (! defined $err and $sth->err);
1692 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1694 $self->throw_exception("Unexpected populate error: $err")
1695 if ($i > $#$tuple_status);
1697 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1698 ($tuple_status->[$i][1] || $err),
1699 Data::Dumper::Concise::Dumper({
1700 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1708 sub _dbh_execute_array {
1709 my ($self, $sth, $tuple_status, @extra) = @_;
1711 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1714 sub _dbh_execute_inserts_with_no_binds {
1715 my ($self, $sth, $count) = @_;
1719 my $dbh = $self->_get_dbh;
1720 local $dbh->{RaiseError} = 1;
1721 local $dbh->{PrintError} = 0;
1723 $sth->execute foreach 1..$count;
1729 # Make sure statement is finished even if there was an exception.
1734 $err = shift unless defined $err;
1738 $self->throw_exception($err) if defined $err;
1744 my ($self, $source, @args) = @_;
1746 my $bind_attrs = $self->source_bind_attributes($source);
1748 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1753 my ($self, $source, @args) = @_;
1755 my $bind_attrs = $self->source_bind_attributes($source);
1757 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1760 # We were sent here because the $rs contains a complex search
1761 # which will require a subquery to select the correct rows
1762 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1764 # Generating a single PK column subquery is trivial and supported
1765 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1766 # Look at _multipk_update_delete()
1767 sub _subq_update_delete {
1769 my ($rs, $op, $values) = @_;
1771 my $rsrc = $rs->result_source;
1773 # quick check if we got a sane rs on our hands
1774 my @pcols = $rsrc->_pri_cols;
1776 my $sel = $rs->_resolved_attrs->{select};
1777 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1780 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1782 join ("\x00", sort @$sel )
1784 $self->throw_exception (
1785 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1792 $op eq 'update' ? $values : (),
1793 { $pcols[0] => { -in => $rs->as_query } },
1798 return $self->_multipk_update_delete (@_);
1802 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1803 # resultset update/delete involving subqueries. So by default resort
1804 # to simple (and inefficient) delete_all style per-row opearations,
1805 # while allowing specific storages to override this with a faster
1808 sub _multipk_update_delete {
1809 return shift->_per_row_update_delete (@_);
1812 # This is the default loop used to delete/update rows for multi PK
1813 # resultsets, and used by mysql exclusively (because it can't do anything
1816 # We do not use $row->$op style queries, because resultset update/delete
1817 # is not expected to cascade (this is what delete_all/update_all is for).
1819 # There should be no race conditions as the entire operation is rolled
1822 sub _per_row_update_delete {
1824 my ($rs, $op, $values) = @_;
1826 my $rsrc = $rs->result_source;
1827 my @pcols = $rsrc->_pri_cols;
1829 my $guard = $self->txn_scope_guard;
1831 # emulate the return value of $sth->execute for non-selects
1832 my $row_cnt = '0E0';
1834 my $subrs_cur = $rs->cursor;
1835 my @all_pk = $subrs_cur->all;
1836 for my $pks ( @all_pk) {
1839 for my $i (0.. $#pcols) {
1840 $cond->{$pcols[$i]} = $pks->[$i];
1845 $op eq 'update' ? $values : (),
1859 $self->_execute($self->_select_args(@_));
1862 sub _select_args_to_query {
1865 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $rs_attrs, $rows, $offset)
1866 # = $self->_select_args($ident, $select, $cond, $attrs);
1867 my ($op, $bind, $ident, $bind_attrs, @args) =
1868 $self->_select_args(@_);
1870 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
1871 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1872 $prepared_bind ||= [];
1875 ? ($sql, $prepared_bind, $bind_attrs)
1876 : \[ "($sql)", @$prepared_bind ]
1881 my ($self, $ident, $select, $where, $attrs) = @_;
1883 my $sql_maker = $self->sql_maker;
1884 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1891 $rs_alias && $alias2source->{$rs_alias}
1892 ? ( _rsroot_source_handle => $alias2source->{$rs_alias}->handle )
1897 # calculate bind_attrs before possible $ident mangling
1898 my $bind_attrs = {};
1899 for my $alias (keys %$alias2source) {
1900 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1901 for my $col (keys %$bindtypes) {
1903 my $fqcn = join ('.', $alias, $col);
1904 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1906 # Unqialified column names are nice, but at the same time can be
1907 # rather ambiguous. What we do here is basically go along with
1908 # the loop, adding an unqualified column slot to $bind_attrs,
1909 # alongside the fully qualified name. As soon as we encounter
1910 # another column by that name (which would imply another table)
1911 # we unset the unqualified slot and never add any info to it
1912 # to avoid erroneous type binding. If this happens the users
1913 # only choice will be to fully qualify his column name
1915 if (exists $bind_attrs->{$col}) {
1916 $bind_attrs->{$col} = {};
1919 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1926 $attrs->{software_limit}
1928 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1930 $attrs->{software_limit} = 1;
1933 $self->throw_exception("rows attribute must be positive if present")
1934 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1936 # MySQL actually recommends this approach. I cringe.
1937 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1942 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1943 # storage, unless software limit was requested
1946 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1948 # grouped prefetch (to satisfy group_by == select)
1949 ( $attrs->{group_by}
1951 @{$attrs->{group_by}}
1953 $attrs->{_prefetch_select}
1955 @{$attrs->{_prefetch_select}}
1958 ($ident, $select, $where, $attrs)
1959 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1961 elsif (! $attrs->{software_limit} ) {
1962 push @limit, $attrs->{rows}, $attrs->{offset};
1965 # try to simplify the joinmap further (prune unreferenced type-single joins)
1966 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1969 # This would be the point to deflate anything found in $where
1970 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1971 # expect a row object. And all we have is a resultsource (it is trivial
1972 # to extract deflator coderefs via $alias2source above).
1974 # I don't see a way forward other than changing the way deflators are
1975 # invoked, and that's just bad...
1978 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $attrs, @limit);
1981 # Returns a counting SELECT for a simple count
1982 # query. Abstracted so that a storage could override
1983 # this to { count => 'firstcol' } or whatever makes
1984 # sense as a performance optimization
1986 #my ($self, $source, $rs_attrs) = @_;
1987 return { count => '*' };
1991 sub source_bind_attributes {
1992 my ($self, $source) = @_;
1994 my $bind_attributes;
1995 foreach my $column ($source->columns) {
1997 my $data_type = $source->column_info($column)->{data_type} || '';
1998 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
2002 return $bind_attributes;
2009 =item Arguments: $ident, $select, $condition, $attrs
2013 Handle a SQL select statement.
2019 my ($ident, $select, $condition, $attrs) = @_;
2020 return $self->cursor_class->new($self, \@_, $attrs);
2025 my ($rv, $sth, @bind) = $self->_select(@_);
2026 my @row = $sth->fetchrow_array;
2027 my @nextrow = $sth->fetchrow_array if @row;
2028 if(@row && @nextrow) {
2029 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2031 # Need to call finish() to work round broken DBDs
2040 =item Arguments: $sql
2044 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2049 my ($self, $dbh, $sql) = @_;
2051 # 3 is the if_active parameter which avoids active sth re-use
2052 my $sth = $self->disable_sth_caching
2053 ? $dbh->prepare($sql)
2054 : $dbh->prepare_cached($sql, {}, 3);
2056 # XXX You would think RaiseError would make this impossible,
2057 # but apparently that's not true :(
2058 $self->throw_exception($dbh->errstr) if !$sth;
2064 my ($self, $sql) = @_;
2065 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2068 sub _dbh_columns_info_for {
2069 my ($self, $dbh, $table) = @_;
2071 if ($dbh->can('column_info')) {
2075 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2076 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2078 while ( my $info = $sth->fetchrow_hashref() ){
2080 $column_info{data_type} = $info->{TYPE_NAME};
2081 $column_info{size} = $info->{COLUMN_SIZE};
2082 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2083 $column_info{default_value} = $info->{COLUMN_DEF};
2084 my $col_name = $info->{COLUMN_NAME};
2085 $col_name =~ s/^\"(.*)\"$/$1/;
2087 $result{$col_name} = \%column_info;
2092 return \%result if !$caught && scalar keys %result;
2096 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2098 my @columns = @{$sth->{NAME_lc}};
2099 for my $i ( 0 .. $#columns ){
2101 $column_info{data_type} = $sth->{TYPE}->[$i];
2102 $column_info{size} = $sth->{PRECISION}->[$i];
2103 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2105 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2106 $column_info{data_type} = $1;
2107 $column_info{size} = $2;
2110 $result{$columns[$i]} = \%column_info;
2114 foreach my $col (keys %result) {
2115 my $colinfo = $result{$col};
2116 my $type_num = $colinfo->{data_type};
2118 if(defined $type_num && $dbh->can('type_info')) {
2119 my $type_info = $dbh->type_info($type_num);
2120 $type_name = $type_info->{TYPE_NAME} if $type_info;
2121 $colinfo->{data_type} = $type_name if $type_name;
2128 sub columns_info_for {
2129 my ($self, $table) = @_;
2130 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2133 =head2 last_insert_id
2135 Return the row id of the last insert.
2139 sub _dbh_last_insert_id {
2140 my ($self, $dbh, $source, $col) = @_;
2142 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2144 return $id if defined $id;
2146 my $class = ref $self;
2147 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2150 sub last_insert_id {
2152 $self->_dbh_last_insert_id ($self->_dbh, @_);
2155 =head2 _native_data_type
2159 =item Arguments: $type_name
2163 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2164 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2165 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2167 The default implementation returns C<undef>, implement in your Storage driver if
2168 you need this functionality.
2170 Should map types from other databases to the native RDBMS type, for example
2171 C<VARCHAR2> to C<VARCHAR>.
2173 Types with modifiers should map to the underlying data type. For example,
2174 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2176 Composite types should map to the container type, for example
2177 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2181 sub _native_data_type {
2182 #my ($self, $data_type) = @_;
2186 # Check if placeholders are supported at all
2187 sub _placeholders_supported {
2189 my $dbh = $self->_get_dbh;
2191 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2192 # but it is inaccurate more often than not
2194 local $dbh->{PrintError} = 0;
2195 local $dbh->{RaiseError} = 1;
2196 $dbh->do('select ?', {}, 1);
2204 # Check if placeholders bound to non-string types throw exceptions
2206 sub _typeless_placeholders_supported {
2208 my $dbh = $self->_get_dbh;
2211 local $dbh->{PrintError} = 0;
2212 local $dbh->{RaiseError} = 1;
2213 # this specifically tests a bind that is NOT a string
2214 $dbh->do('select 1 where 1 = ?', {}, 1);
2224 Returns the database driver name.
2229 shift->_get_dbh->{Driver}->{Name};
2232 =head2 bind_attribute_by_data_type
2234 Given a datatype from column info, returns a database specific bind
2235 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2236 let the database planner just handle it.
2238 Generally only needed for special case column types, like bytea in postgres.
2242 sub bind_attribute_by_data_type {
2246 =head2 is_datatype_numeric
2248 Given a datatype from column_info, returns a boolean value indicating if
2249 the current RDBMS considers it a numeric value. This controls how
2250 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2251 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2252 be performed instead of the usual C<eq>.
2256 sub is_datatype_numeric {
2257 my ($self, $dt) = @_;
2259 return 0 unless $dt;
2261 return $dt =~ /^ (?:
2262 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2267 =head2 create_ddl_dir
2271 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2275 Creates a SQL file based on the Schema, for each of the specified
2276 database engines in C<\@databases> in the given directory.
2277 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2279 Given a previous version number, this will also create a file containing
2280 the ALTER TABLE statements to transform the previous schema into the
2281 current one. Note that these statements may contain C<DROP TABLE> or
2282 C<DROP COLUMN> statements that can potentially destroy data.
2284 The file names are created using the C<ddl_filename> method below, please
2285 override this method in your schema if you would like a different file
2286 name format. For the ALTER file, the same format is used, replacing
2287 $version in the name with "$preversion-$version".
2289 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2290 The most common value for this would be C<< { add_drop_table => 1 } >>
2291 to have the SQL produced include a C<DROP TABLE> statement for each table
2292 created. For quoting purposes supply C<quote_table_names> and
2293 C<quote_field_names>.
2295 If no arguments are passed, then the following default values are assumed:
2299 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2301 =item version - $schema->schema_version
2303 =item directory - './'
2305 =item preversion - <none>
2309 By default, C<\%sqlt_args> will have
2311 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2313 merged with the hash passed in. To disable any of those features, pass in a
2314 hashref like the following
2316 { ignore_constraint_names => 0, # ... other options }
2319 WARNING: You are strongly advised to check all SQL files created, before applying
2324 sub create_ddl_dir {
2325 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2328 carp "No directory given, using ./\n";
2331 -d $dir or File::Path::mkpath($dir)
2332 or $self->throw_exception("create_ddl_dir: $! creating dir '$dir'");
2335 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2337 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2338 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2340 my $schema_version = $schema->schema_version || '1.x';
2341 $version ||= $schema_version;
2344 add_drop_table => 1,
2345 ignore_constraint_names => 1,
2346 ignore_index_names => 1,
2350 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2351 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2354 my $sqlt = SQL::Translator->new( $sqltargs );
2356 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2357 my $sqlt_schema = $sqlt->translate({ data => $schema })
2358 or $self->throw_exception ($sqlt->error);
2360 foreach my $db (@$databases) {
2362 $sqlt->{schema} = $sqlt_schema;
2363 $sqlt->producer($db);
2366 my $filename = $schema->ddl_filename($db, $version, $dir);
2367 if (-e $filename && ($version eq $schema_version )) {
2368 # if we are dumping the current version, overwrite the DDL
2369 carp "Overwriting existing DDL file - $filename";
2373 my $output = $sqlt->translate;
2375 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2378 if(!open($file, ">$filename")) {
2379 $self->throw_exception("Can't open $filename for writing ($!)");
2382 print $file $output;
2385 next unless ($preversion);
2387 require SQL::Translator::Diff;
2389 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2390 if(!-e $prefilename) {
2391 carp("No previous schema file found ($prefilename)");
2395 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2397 carp("Overwriting existing diff file - $difffile");
2403 my $t = SQL::Translator->new($sqltargs);
2408 or $self->throw_exception ($t->error);
2410 my $out = $t->translate( $prefilename )
2411 or $self->throw_exception ($t->error);
2413 $source_schema = $t->schema;
2415 $source_schema->name( $prefilename )
2416 unless ( $source_schema->name );
2419 # The "new" style of producers have sane normalization and can support
2420 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2421 # And we have to diff parsed SQL against parsed SQL.
2422 my $dest_schema = $sqlt_schema;
2424 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2425 my $t = SQL::Translator->new($sqltargs);
2430 or $self->throw_exception ($t->error);
2432 my $out = $t->translate( $filename )
2433 or $self->throw_exception ($t->error);
2435 $dest_schema = $t->schema;
2437 $dest_schema->name( $filename )
2438 unless $dest_schema->name;
2441 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2445 if(!open $file, ">$difffile") {
2446 $self->throw_exception("Can't write to $difffile ($!)");
2454 =head2 deployment_statements
2458 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2462 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2464 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2465 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2467 C<$directory> is used to return statements from files in a previously created
2468 L</create_ddl_dir> directory and is optional. The filenames are constructed
2469 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2471 If no C<$directory> is specified then the statements are constructed on the
2472 fly using L<SQL::Translator> and C<$version> is ignored.
2474 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2478 sub deployment_statements {
2479 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2480 $type ||= $self->sqlt_type;
2481 $version ||= $schema->schema_version || '1.x';
2483 my $filename = $schema->ddl_filename($type, $version, $dir);
2487 open($file, "<$filename")
2488 or $self->throw_exception("Can't open $filename ($!)");
2491 return join('', @rows);
2494 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2495 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2498 # sources needs to be a parser arg, but for simplicty allow at top level
2500 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2501 if exists $sqltargs->{sources};
2503 my $tr = SQL::Translator->new(
2504 producer => "SQL::Translator::Producer::${type}",
2506 parser => 'SQL::Translator::Parser::DBIx::Class',
2513 @ret = $tr->translate;
2516 $ret[0] = $tr->translate;
2519 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2520 unless (@ret && defined $ret[0]);
2522 return $wa ? @ret : $ret[0];
2526 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2529 return if($line =~ /^--/);
2531 # next if($line =~ /^DROP/m);
2532 return if($line =~ /^BEGIN TRANSACTION/m);
2533 return if($line =~ /^COMMIT/m);
2534 return if $line =~ /^\s+$/; # skip whitespace only
2535 $self->_query_start($line);
2537 # do a dbh_do cycle here, as we need some error checking in
2538 # place (even though we will ignore errors)
2539 $self->dbh_do (sub { $_[1]->do($line) });
2541 carp qq{$_ (running "${line}")};
2543 $self->_query_end($line);
2545 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2546 if (@statements > 1) {
2547 foreach my $statement (@statements) {
2548 $deploy->( $statement );
2551 elsif (@statements == 1) {
2552 foreach my $line ( split(";\n", $statements[0])) {
2558 =head2 datetime_parser
2560 Returns the datetime parser class
2564 sub datetime_parser {
2566 return $self->{datetime_parser} ||= do {
2567 $self->build_datetime_parser(@_);
2571 =head2 datetime_parser_type
2573 Defines (returns) the datetime parser class - currently hardwired to
2574 L<DateTime::Format::MySQL>
2578 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2580 =head2 build_datetime_parser
2582 See L</datetime_parser>
2586 sub build_datetime_parser {
2588 my $type = $self->datetime_parser_type(@_);
2589 $self->ensure_class_loaded ($type);
2594 =head2 is_replicating
2596 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2597 replicate from a master database. Default is undef, which is the result
2598 returned by databases that don't support replication.
2602 sub is_replicating {
2607 =head2 lag_behind_master
2609 Returns a number that represents a certain amount of lag behind a master db
2610 when a given storage is replicating. The number is database dependent, but
2611 starts at zero and increases with the amount of lag. Default in undef
2615 sub lag_behind_master {
2619 =head2 relname_to_table_alias
2623 =item Arguments: $relname, $join_count
2627 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2630 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2631 way these aliases are named.
2633 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2634 otherwise C<"$relname">.
2638 sub relname_to_table_alias {
2639 my ($self, $relname, $join_count) = @_;
2641 my $alias = ($join_count && $join_count > 1 ?
2642 join('_', $relname, $join_count) : $relname);
2651 =head2 DBIx::Class and AutoCommit
2653 DBIx::Class can do some wonderful magic with handling exceptions,
2654 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2655 (the default) combined with C<txn_do> for transaction support.
2657 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2658 in an assumed transaction between commits, and you're telling us you'd
2659 like to manage that manually. A lot of the magic protections offered by
2660 this module will go away. We can't protect you from exceptions due to database
2661 disconnects because we don't know anything about how to restart your
2662 transactions. You're on your own for handling all sorts of exceptional
2663 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2669 Matt S. Trout <mst@shadowcatsystems.co.uk>
2671 Andy Grundman <andy@hybridized.org>
2675 You may distribute this code under the same terms as Perl itself.