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();
19 __PACKAGE__->mk_group_accessors('simple' =>
20 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
21 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints/
24 # the values for these accessors are picked out (and deleted) from
25 # the attribute hashref passed to connect_info
26 my @storage_options = qw/
27 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
28 disable_sth_caching unsafe auto_savepoint
30 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
33 # default cursor class, overridable in connect_info attributes
34 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
36 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
37 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
40 # Each of these methods need _determine_driver called before itself
41 # in order to function reliably. This is a purely DRY optimization
42 my @rdbms_specific_methods = qw/
56 for my $meth (@rdbms_specific_methods) {
58 my $orig = __PACKAGE__->can ($meth)
62 no warnings qw/redefine/;
63 *{__PACKAGE__ ."::$meth"} = Sub::Name::subname $meth => sub {
64 if (not $_[0]->_driver_determined) {
65 $_[0]->_determine_driver;
66 goto $_[0]->can($meth);
75 DBIx::Class::Storage::DBI - DBI storage handler
79 my $schema = MySchema->connect('dbi:SQLite:my.db');
81 $schema->storage->debug(1);
83 my @stuff = $schema->storage->dbh_do(
85 my ($storage, $dbh, @args) = @_;
86 $dbh->do("DROP TABLE authors");
91 $schema->resultset('Book')->search({
92 written_on => $schema->storage->datetime_parser(DateTime->now)
97 This class represents the connection to an RDBMS via L<DBI>. See
98 L<DBIx::Class::Storage> for general information. This pod only
99 documents DBI-specific methods and behaviors.
106 my $new = shift->next::method(@_);
108 $new->transaction_depth(0);
109 $new->_sql_maker_opts({});
110 $new->{savepoints} = [];
111 $new->{_in_dbh_do} = 0;
112 $new->{_dbh_gen} = 0;
119 This method is normally called by L<DBIx::Class::Schema/connection>, which
120 encapsulates its argument list in an arrayref before passing them here.
122 The argument list may contain:
128 The same 4-element argument set one would normally pass to
129 L<DBI/connect>, optionally followed by
130 L<extra attributes|/DBIx::Class specific connection attributes>
131 recognized by DBIx::Class:
133 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
137 A single code reference which returns a connected
138 L<DBI database handle|DBI/connect> optionally followed by
139 L<extra attributes|/DBIx::Class specific connection attributes> recognized
142 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
146 A single hashref with all the attributes and the dsn/user/password
149 $connect_info_args = [{
157 $connect_info_args = [{
158 dbh_maker => sub { DBI->connect (...) },
163 This is particularly useful for L<Catalyst> based applications, allowing the
164 following config (L<Config::General> style):
169 dsn dbi:mysql:database=test
176 The C<dsn>/C<user>/C<password> combination can be substituted by the
177 C<dbh_maker> key whose value is a coderef that returns a connected
178 L<DBI database handle|DBI/connect>
182 Please note that the L<DBI> docs recommend that you always explicitly
183 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
184 recommends that it be set to I<1>, and that you perform transactions
185 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
186 to I<1> if you do not do explicitly set it to zero. This is the default
187 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
189 =head3 DBIx::Class specific connection attributes
191 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
192 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
193 the following connection options. These options can be mixed in with your other
194 L<DBI> connection attributes, or placed in a separate hashref
195 (C<\%extra_attributes>) as shown above.
197 Every time C<connect_info> is invoked, any previous settings for
198 these options will be cleared before setting the new ones, regardless of
199 whether any options are specified in the new C<connect_info>.
206 Specifies things to do immediately after connecting or re-connecting to
207 the database. Its value may contain:
213 This contains one SQL statement to execute.
215 =item an array reference
217 This contains SQL statements to execute in order. Each element contains
218 a string or a code reference that returns a string.
220 =item a code reference
222 This contains some code to execute. Unlike code references within an
223 array reference, its return value is ignored.
227 =item on_disconnect_do
229 Takes arguments in the same form as L</on_connect_do> and executes them
230 immediately before disconnecting from the database.
232 Note, this only runs if you explicitly call L</disconnect> on the
235 =item on_connect_call
237 A more generalized form of L</on_connect_do> that calls the specified
238 C<connect_call_METHOD> methods in your storage driver.
240 on_connect_do => 'select 1'
244 on_connect_call => [ [ do_sql => 'select 1' ] ]
246 Its values may contain:
252 Will call the C<connect_call_METHOD> method.
254 =item a code reference
256 Will execute C<< $code->($storage) >>
258 =item an array reference
260 Each value can be a method name or code reference.
262 =item an array of arrays
264 For each array, the first item is taken to be the C<connect_call_> method name
265 or code reference, and the rest are parameters to it.
269 Some predefined storage methods you may use:
275 Executes a SQL string or a code reference that returns a SQL string. This is
276 what L</on_connect_do> and L</on_disconnect_do> use.
284 Will execute the scalar as SQL.
288 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
289 attributes hashref and bind values.
291 =item a code reference
293 Will execute C<< $code->($storage) >> and execute the return array refs as
300 Execute any statements necessary to initialize the database session to return
301 and accept datetime/timestamp values used with
302 L<DBIx::Class::InflateColumn::DateTime>.
304 Only necessary for some databases, see your specific storage driver for
305 implementation details.
309 =item on_disconnect_call
311 Takes arguments in the same form as L</on_connect_call> and executes them
312 immediately before disconnecting from the database.
314 Calls the C<disconnect_call_METHOD> methods as opposed to the
315 C<connect_call_METHOD> methods called by L</on_connect_call>.
317 Note, this only runs if you explicitly call L</disconnect> on the
320 =item disable_sth_caching
322 If set to a true value, this option will disable the caching of
323 statement handles via L<DBI/prepare_cached>.
327 Sets the limit dialect. This is useful for JDBC-bridge among others
328 where the remote SQL-dialect cannot be determined by the name of the
329 driver alone. See also L<SQL::Abstract::Limit>.
333 Specifies what characters to use to quote table and column names. If
334 you use this you will want to specify L</name_sep> as well.
336 C<quote_char> expects either a single character, in which case is it
337 is placed on either side of the table/column name, or an arrayref of length
338 2 in which case the table/column name is placed between the elements.
340 For example under MySQL you should use C<< quote_char => '`' >>, and for
341 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
345 This only needs to be used in conjunction with C<quote_char>, and is used to
346 specify the character that separates elements (schemas, tables, columns) from
347 each other. In most cases this is simply a C<.>.
349 The consequences of not supplying this value is that L<SQL::Abstract>
350 will assume DBIx::Class' uses of aliases to be complete column
351 names. The output will look like I<"me.name"> when it should actually
356 This Storage driver normally installs its own C<HandleError>, sets
357 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
358 all database handles, including those supplied by a coderef. It does this
359 so that it can have consistent and useful error behavior.
361 If you set this option to a true value, Storage will not do its usual
362 modifications to the database handle's attributes, and instead relies on
363 the settings in your connect_info DBI options (or the values you set in
364 your connection coderef, in the case that you are connecting via coderef).
366 Note that your custom settings can cause Storage to malfunction,
367 especially if you set a C<HandleError> handler that suppresses exceptions
368 and/or disable C<RaiseError>.
372 If this option is true, L<DBIx::Class> will use savepoints when nesting
373 transactions, making it possible to recover from failure in the inner
374 transaction without having to abort all outer transactions.
378 Use this argument to supply a cursor class other than the default
379 L<DBIx::Class::Storage::DBI::Cursor>.
383 Some real-life examples of arguments to L</connect_info> and
384 L<DBIx::Class::Schema/connect>
386 # Simple SQLite connection
387 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
390 ->connect_info([ sub { DBI->connect(...) } ]);
392 # Connect via subref in hashref
394 dbh_maker => sub { DBI->connect(...) },
395 on_connect_do => 'alter session ...',
398 # A bit more complicated
405 { quote_char => q{"}, name_sep => q{.} },
409 # Equivalent to the previous example
415 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
419 # Same, but with hashref as argument
420 # See parse_connect_info for explanation
423 dsn => 'dbi:Pg:dbname=foo',
425 password => 'my_pg_password',
432 # Subref + DBIx::Class-specific connection options
435 sub { DBI->connect(...) },
439 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
440 disable_sth_caching => 1,
450 my ($self, $info) = @_;
452 return $self->_connect_info if !$info;
454 $self->_connect_info($info); # copy for _connect_info
456 $info = $self->_normalize_connect_info($info)
457 if ref $info eq 'ARRAY';
459 for my $storage_opt (keys %{ $info->{storage_options} }) {
460 my $value = $info->{storage_options}{$storage_opt};
462 $self->$storage_opt($value);
465 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
466 # the new set of options
467 $self->_sql_maker(undef);
468 $self->_sql_maker_opts({});
470 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
471 my $value = $info->{sql_maker_options}{$sql_maker_opt};
473 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
477 %{ $self->_default_dbi_connect_attributes || {} },
478 %{ $info->{attributes} || {} },
481 my @args = @{ $info->{arguments} };
483 $self->_dbi_connect_info([@args,
484 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
486 return $self->_connect_info;
489 sub _normalize_connect_info {
490 my ($self, $info_arg) = @_;
493 my @args = @$info_arg; # take a shallow copy for further mutilation
495 # combine/pre-parse arguments depending on invocation style
498 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
499 %attrs = %{ $args[1] || {} };
502 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
503 %attrs = %{$args[0]};
505 if (my $code = delete $attrs{dbh_maker}) {
508 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
511 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
512 . "to the result of 'dbh_maker'",
514 join (', ', map { "'$_'" } (@ignored) ),
519 @args = delete @attrs{qw/dsn user password/};
522 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
524 % { $args[3] || {} },
525 % { $args[4] || {} },
527 @args = @args[0,1,2];
530 $info{arguments} = \@args;
532 my @storage_opts = grep exists $attrs{$_},
533 @storage_options, 'cursor_class';
535 @{ $info{storage_options} }{@storage_opts} =
536 delete @attrs{@storage_opts} if @storage_opts;
538 my @sql_maker_opts = grep exists $attrs{$_},
539 qw/limit_dialect quote_char name_sep/;
541 @{ $info{sql_maker_options} }{@sql_maker_opts} =
542 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
544 $info{attributes} = \%attrs if %attrs;
549 sub _default_dbi_connect_attributes {
559 This method is deprecated in favour of setting via L</connect_info>.
563 =head2 on_disconnect_do
565 This method is deprecated in favour of setting via L</connect_info>.
569 sub _parse_connect_do {
570 my ($self, $type) = @_;
572 my $val = $self->$type;
573 return () if not defined $val;
578 push @res, [ 'do_sql', $val ];
579 } elsif (ref($val) eq 'CODE') {
581 } elsif (ref($val) eq 'ARRAY') {
582 push @res, map { [ 'do_sql', $_ ] } @$val;
584 $self->throw_exception("Invalid type for $type: ".ref($val));
592 Arguments: ($subref | $method_name), @extra_coderef_args?
594 Execute the given $subref or $method_name using the new exception-based
595 connection management.
597 The first two arguments will be the storage object that C<dbh_do> was called
598 on and a database handle to use. Any additional arguments will be passed
599 verbatim to the called subref as arguments 2 and onwards.
601 Using this (instead of $self->_dbh or $self->dbh) ensures correct
602 exception handling and reconnection (or failover in future subclasses).
604 Your subref should have no side-effects outside of the database, as
605 there is the potential for your subref to be partially double-executed
606 if the database connection was stale/dysfunctional.
610 my @stuff = $schema->storage->dbh_do(
612 my ($storage, $dbh, @cols) = @_;
613 my $cols = join(q{, }, @cols);
614 $dbh->selectrow_array("SELECT $cols FROM foo");
625 my $dbh = $self->_get_dbh;
627 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
628 || $self->{transaction_depth};
630 local $self->{_in_dbh_do} = 1;
633 my $want_array = wantarray;
638 @result = $self->$code($dbh, @_);
640 elsif(defined $want_array) {
641 $result[0] = $self->$code($dbh, @_);
644 $self->$code($dbh, @_);
648 # ->connected might unset $@ - copy
650 if(!$exception) { return $want_array ? @result : $result[0] }
652 $self->throw_exception($exception) if $self->connected;
654 # We were not connected - reconnect and retry, but let any
655 # exception fall right through this time
656 carp "Retrying $code after catching disconnected exception: $exception"
657 if $ENV{DBIC_DBIRETRY_DEBUG};
658 $self->_populate_dbh;
659 $self->$code($self->_dbh, @_);
662 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
663 # It also informs dbh_do to bypass itself while under the direction of txn_do,
664 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
669 ref $coderef eq 'CODE' or $self->throw_exception
670 ('$coderef must be a CODE reference');
672 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
674 local $self->{_in_dbh_do} = 1;
677 my $want_array = wantarray;
686 @result = $coderef->(@_);
688 elsif(defined $want_array) {
689 $result[0] = $coderef->(@_);
697 # ->connected might unset $@ - copy
699 if(!$exception) { return $want_array ? @result : $result[0] }
701 if($tried++ || $self->connected) {
702 eval { $self->txn_rollback };
703 my $rollback_exception = $@;
704 if($rollback_exception) {
705 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
706 $self->throw_exception($exception) # propagate nested rollback
707 if $rollback_exception =~ /$exception_class/;
709 $self->throw_exception(
710 "Transaction aborted: ${exception}. "
711 . "Rollback failed: ${rollback_exception}"
714 $self->throw_exception($exception)
717 # We were not connected, and was first try - reconnect and retry
719 carp "Retrying $coderef after catching disconnected exception: $exception"
720 if $ENV{DBIC_DBIRETRY_DEBUG};
721 $self->_populate_dbh;
727 Our C<disconnect> method also performs a rollback first if the
728 database is not in C<AutoCommit> mode.
738 push @actions, ( $self->on_disconnect_call || () );
739 push @actions, $self->_parse_connect_do ('on_disconnect_do');
741 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
743 $self->_dbh_rollback unless $self->_dbh_autocommit;
745 %{ $self->_dbh->{CachedKids} } = ();
746 $self->_dbh->disconnect;
752 =head2 with_deferred_fk_checks
756 =item Arguments: C<$coderef>
758 =item Return Value: The return value of $coderef
762 Storage specific method to run the code ref with FK checks deferred or
763 in MySQL's case disabled entirely.
767 # Storage subclasses should override this
768 sub with_deferred_fk_checks {
769 my ($self, $sub) = @_;
777 =item Arguments: none
779 =item Return Value: 1|0
783 Verifies that the current database handle is active and ready to execute
784 an SQL statement (e.g. the connection did not get stale, server is still
785 answering, etc.) This method is used internally by L</dbh>.
791 return 0 unless $self->_seems_connected;
794 local $self->_dbh->{RaiseError} = 1;
799 sub _seems_connected {
802 my $dbh = $self->_dbh
805 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
812 return 0 if !$self->_dbh;
815 return $dbh->FETCH('Active');
821 my $dbh = $self->_dbh or return 0;
826 # handle pid changes correctly
827 # NOTE: assumes $self->_dbh is a valid $dbh
831 return if defined $self->_conn_pid && $self->_conn_pid == $$;
833 $self->_dbh->{InactiveDestroy} = 1;
840 sub ensure_connected {
843 unless ($self->connected) {
844 $self->_populate_dbh;
850 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
851 is guaranteed to be healthy by implicitly calling L</connected>, and if
852 necessary performing a reconnection before returning. Keep in mind that this
853 is very B<expensive> on some database engines. Consider using L<dbh_do>
861 if (not $self->_dbh) {
862 $self->_populate_dbh;
864 $self->ensure_connected;
869 # this is the internal "get dbh or connect (don't check)" method
872 $self->_verify_pid if $self->_dbh;
873 $self->_populate_dbh unless $self->_dbh;
877 sub _sql_maker_args {
882 array_datatypes => 1,
883 limit_dialect => $self->_get_dbh,
884 %{$self->_sql_maker_opts}
890 unless ($self->_sql_maker) {
891 my $sql_maker_class = $self->sql_maker_class;
892 $self->ensure_class_loaded ($sql_maker_class);
893 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
895 return $self->_sql_maker;
898 # nothing to do by default
905 my @info = @{$self->_dbi_connect_info || []};
906 $self->_dbh(undef); # in case ->connected failed we might get sent here
907 $self->_dbh($self->_connect(@info));
909 $self->_conn_pid($$);
910 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
912 $self->_determine_driver;
914 # Always set the transaction depth on connect, since
915 # there is no transaction in progress by definition
916 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
918 $self->_run_connection_actions unless $self->{_in_determine_driver};
921 sub _run_connection_actions {
925 push @actions, ( $self->on_connect_call || () );
926 push @actions, $self->_parse_connect_do ('on_connect_do');
928 $self->_do_connection_actions(connect_call_ => $_) for @actions;
931 sub _determine_driver {
934 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
935 my $started_connected = 0;
936 local $self->{_in_determine_driver} = 1;
938 if (ref($self) eq __PACKAGE__) {
940 if ($self->_dbh) { # we are connected
941 $driver = $self->_dbh->{Driver}{Name};
942 $started_connected = 1;
944 # if connect_info is a CODEREF, we have no choice but to connect
945 if (ref $self->_dbi_connect_info->[0] &&
946 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
947 $self->_populate_dbh;
948 $driver = $self->_dbh->{Driver}{Name};
951 # try to use dsn to not require being connected, the driver may still
952 # force a connection in _rebless to determine version
953 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
957 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
958 if ($self->load_optional_class($storage_class)) {
959 mro::set_mro($storage_class, 'c3');
960 bless $self, $storage_class;
965 $self->_driver_determined(1);
967 $self->_init; # run driver-specific initializations
969 $self->_run_connection_actions
970 if !$started_connected && defined $self->_dbh;
974 sub _do_connection_actions {
976 my $method_prefix = shift;
979 if (not ref($call)) {
980 my $method = $method_prefix . $call;
982 } elsif (ref($call) eq 'CODE') {
984 } elsif (ref($call) eq 'ARRAY') {
985 if (ref($call->[0]) ne 'ARRAY') {
986 $self->_do_connection_actions($method_prefix, $_) for @$call;
988 $self->_do_connection_actions($method_prefix, @$_) for @$call;
991 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
997 sub connect_call_do_sql {
999 $self->_do_query(@_);
1002 sub disconnect_call_do_sql {
1004 $self->_do_query(@_);
1007 # override in db-specific backend when necessary
1008 sub connect_call_datetime_setup { 1 }
1011 my ($self, $action) = @_;
1013 if (ref $action eq 'CODE') {
1014 $action = $action->($self);
1015 $self->_do_query($_) foreach @$action;
1018 # Most debuggers expect ($sql, @bind), so we need to exclude
1019 # the attribute hash which is the second argument to $dbh->do
1020 # furthermore the bind values are usually to be presented
1021 # as named arrayref pairs, so wrap those here too
1022 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1023 my $sql = shift @do_args;
1024 my $attrs = shift @do_args;
1025 my @bind = map { [ undef, $_ ] } @do_args;
1027 $self->_query_start($sql, @bind);
1028 $self->_get_dbh->do($sql, $attrs, @do_args);
1029 $self->_query_end($sql, @bind);
1036 my ($self, @info) = @_;
1038 $self->throw_exception("You failed to provide any connection info")
1041 my ($old_connect_via, $dbh);
1043 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1044 $old_connect_via = $DBI::connect_via;
1045 $DBI::connect_via = 'connect';
1049 if(ref $info[0] eq 'CODE') {
1050 $dbh = $info[0]->();
1053 $dbh = DBI->connect(@info);
1056 if($dbh && !$self->unsafe) {
1057 my $weak_self = $self;
1058 Scalar::Util::weaken($weak_self);
1059 $dbh->{HandleError} = sub {
1061 $weak_self->throw_exception("DBI Exception: $_[0]");
1064 # the handler may be invoked by something totally out of
1066 croak ("DBI Exception: $_[0]");
1069 $dbh->{ShowErrorStatement} = 1;
1070 $dbh->{RaiseError} = 1;
1071 $dbh->{PrintError} = 0;
1075 $DBI::connect_via = $old_connect_via if $old_connect_via;
1077 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1080 $self->_dbh_autocommit($dbh->{AutoCommit});
1086 my ($self, $name) = @_;
1088 $name = $self->_svp_generate_name
1089 unless defined $name;
1091 $self->throw_exception ("You can't use savepoints outside a transaction")
1092 if $self->{transaction_depth} == 0;
1094 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1095 unless $self->can('_svp_begin');
1097 push @{ $self->{savepoints} }, $name;
1099 $self->debugobj->svp_begin($name) if $self->debug;
1101 return $self->_svp_begin($name);
1105 my ($self, $name) = @_;
1107 $self->throw_exception ("You can't use savepoints outside a transaction")
1108 if $self->{transaction_depth} == 0;
1110 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1111 unless $self->can('_svp_release');
1113 if (defined $name) {
1114 $self->throw_exception ("Savepoint '$name' does not exist")
1115 unless grep { $_ eq $name } @{ $self->{savepoints} };
1117 # Dig through the stack until we find the one we are releasing. This keeps
1118 # the stack up to date.
1121 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1123 $name = pop @{ $self->{savepoints} };
1126 $self->debugobj->svp_release($name) if $self->debug;
1128 return $self->_svp_release($name);
1132 my ($self, $name) = @_;
1134 $self->throw_exception ("You can't use savepoints outside a transaction")
1135 if $self->{transaction_depth} == 0;
1137 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1138 unless $self->can('_svp_rollback');
1140 if (defined $name) {
1141 # If they passed us a name, verify that it exists in the stack
1142 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1143 $self->throw_exception("Savepoint '$name' does not exist!");
1146 # Dig through the stack until we find the one we are releasing. This keeps
1147 # the stack up to date.
1148 while(my $s = pop(@{ $self->{savepoints} })) {
1149 last if($s eq $name);
1151 # Add the savepoint back to the stack, as a rollback doesn't remove the
1152 # named savepoint, only everything after it.
1153 push(@{ $self->{savepoints} }, $name);
1155 # We'll assume they want to rollback to the last savepoint
1156 $name = $self->{savepoints}->[-1];
1159 $self->debugobj->svp_rollback($name) if $self->debug;
1161 return $self->_svp_rollback($name);
1164 sub _svp_generate_name {
1167 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1173 # this means we have not yet connected and do not know the AC status
1174 # (e.g. coderef $dbh)
1175 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1177 if($self->{transaction_depth} == 0) {
1178 $self->debugobj->txn_begin()
1180 $self->_dbh_begin_work;
1182 elsif ($self->auto_savepoint) {
1185 $self->{transaction_depth}++;
1188 sub _dbh_begin_work {
1191 # if the user is utilizing txn_do - good for him, otherwise we need to
1192 # ensure that the $dbh is healthy on BEGIN.
1193 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1194 # will be replaced by a failure of begin_work itself (which will be
1195 # then retried on reconnect)
1196 if ($self->{_in_dbh_do}) {
1197 $self->_dbh->begin_work;
1199 $self->dbh_do(sub { $_[1]->begin_work });
1205 if ($self->{transaction_depth} == 1) {
1206 $self->debugobj->txn_commit()
1209 $self->{transaction_depth} = 0
1210 if $self->_dbh_autocommit;
1212 elsif($self->{transaction_depth} > 1) {
1213 $self->{transaction_depth}--;
1215 if $self->auto_savepoint;
1221 my $dbh = $self->_dbh
1222 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1228 my $dbh = $self->_dbh;
1230 if ($self->{transaction_depth} == 1) {
1231 $self->debugobj->txn_rollback()
1233 $self->{transaction_depth} = 0
1234 if $self->_dbh_autocommit;
1235 $self->_dbh_rollback;
1237 elsif($self->{transaction_depth} > 1) {
1238 $self->{transaction_depth}--;
1239 if ($self->auto_savepoint) {
1240 $self->svp_rollback;
1245 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1250 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1251 $error =~ /$exception_class/ and $self->throw_exception($error);
1252 # ensure that a failed rollback resets the transaction depth
1253 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1254 $self->throw_exception($error);
1260 my $dbh = $self->_dbh
1261 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1265 # This used to be the top-half of _execute. It was split out to make it
1266 # easier to override in NoBindVars without duping the rest. It takes up
1267 # all of _execute's args, and emits $sql, @bind.
1268 sub _prep_for_execute {
1269 my ($self, $op, $extra_bind, $ident, $args) = @_;
1271 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1272 $ident = $ident->from();
1275 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1278 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1280 return ($sql, \@bind);
1284 sub _fix_bind_params {
1285 my ($self, @bind) = @_;
1287 ### Turn @bind from something like this:
1288 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1290 ### ( "'1'", "'1'", "'3'" )
1293 if ( defined( $_ && $_->[1] ) ) {
1294 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1301 my ( $self, $sql, @bind ) = @_;
1303 if ( $self->debug ) {
1304 @bind = $self->_fix_bind_params(@bind);
1306 $self->debugobj->query_start( $sql, @bind );
1311 my ( $self, $sql, @bind ) = @_;
1313 if ( $self->debug ) {
1314 @bind = $self->_fix_bind_params(@bind);
1315 $self->debugobj->query_end( $sql, @bind );
1320 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1322 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1324 $self->_query_start( $sql, @$bind );
1326 my $sth = $self->sth($sql,$op);
1328 my $placeholder_index = 1;
1330 foreach my $bound (@$bind) {
1331 my $attributes = {};
1332 my($column_name, @data) = @$bound;
1334 if ($bind_attributes) {
1335 $attributes = $bind_attributes->{$column_name}
1336 if defined $bind_attributes->{$column_name};
1339 foreach my $data (@data) {
1340 my $ref = ref $data;
1341 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1343 $sth->bind_param($placeholder_index, $data, $attributes);
1344 $placeholder_index++;
1348 # Can this fail without throwing an exception anyways???
1349 my $rv = $sth->execute();
1350 $self->throw_exception($sth->errstr) if !$rv;
1352 $self->_query_end( $sql, @$bind );
1354 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1359 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1363 my ($self, $source, $to_insert) = @_;
1365 my $ident = $source->from;
1366 my $bind_attributes = $self->source_bind_attributes($source);
1368 my $updated_cols = {};
1370 foreach my $col ( $source->columns ) {
1371 if ( !defined $to_insert->{$col} ) {
1372 my $col_info = $source->column_info($col);
1374 if ( $col_info->{auto_nextval} ) {
1375 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1377 $col_info->{sequence} ||
1378 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1384 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1386 return $updated_cols;
1389 ## Currently it is assumed that all values passed will be "normal", i.e. not
1390 ## scalar refs, or at least, all the same type as the first set, the statement is
1391 ## only prepped once.
1393 my ($self, $source, $cols, $data) = @_;
1396 @colvalues{@$cols} = (0..$#$cols);
1398 for my $i (0..$#$cols) {
1399 my $first_val = $data->[0][$i];
1400 next unless ref $first_val eq 'SCALAR';
1402 $colvalues{ $cols->[$i] } = $first_val;
1405 # check for bad data and stringify stringifiable objects
1406 my $bad_slice = sub {
1407 my ($msg, $col_idx, $slice_idx) = @_;
1408 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1412 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1413 Data::Dumper::Concise::Dumper({
1414 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1420 for my $datum_idx (0..$#$data) {
1421 my $datum = $data->[$datum_idx];
1423 for my $col_idx (0..$#$cols) {
1424 my $val = $datum->[$col_idx];
1425 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1426 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1428 if ($is_literal_sql) {
1430 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1432 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1433 $bad_slice->("$reftype reference found where literal SQL expected",
1434 $col_idx, $datum_idx);
1436 elsif ($$val ne $$sqla_bind){
1437 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1438 $col_idx, $datum_idx);
1441 elsif (my $reftype = ref $val) {
1443 if (overload::Method($val, '""')) {
1444 $datum->[$col_idx] = "".$val;
1447 $bad_slice->("$reftype reference found where bind expected",
1448 $col_idx, $datum_idx);
1454 my ($sql, $bind) = $self->_prep_for_execute (
1455 'insert', undef, $source, [\%colvalues]
1459 my $empty_bind = 1 if (not @bind) &&
1460 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1462 if ((not @bind) && (not $empty_bind)) {
1463 $self->throw_exception(
1464 'Cannot insert_bulk without support for placeholders'
1468 # neither _execute_array, nor _execute_inserts_with_no_binds are
1469 # atomic (even if _execute _array is a single call). Thus a safety
1471 my $guard = $self->txn_scope_guard unless $self->{transaction_depth} != 0;
1473 $self->_query_start( $sql, ['__BULK__'] );
1474 my $sth = $self->sth($sql);
1477 # bind_param_array doesn't work if there are no binds
1478 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1481 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1482 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1486 $self->_query_end( $sql, ['__BULK__'] );
1489 $guard->commit if $guard;
1491 return (wantarray ? ($rv, $sth, @bind) : $rv);
1494 sub _execute_array {
1495 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1497 ## This must be an arrayref, else nothing works!
1498 my $tuple_status = [];
1500 ## Get the bind_attributes, if any exist
1501 my $bind_attributes = $self->source_bind_attributes($source);
1503 ## Bind the values and execute
1504 my $placeholder_index = 1;
1506 foreach my $bound (@$bind) {
1508 my $attributes = {};
1509 my ($column_name, $data_index) = @$bound;
1511 if( $bind_attributes ) {
1512 $attributes = $bind_attributes->{$column_name}
1513 if defined $bind_attributes->{$column_name};
1516 my @data = map { $_->[$data_index] } @$data;
1518 $sth->bind_param_array(
1521 (%$attributes ? $attributes : ()),
1523 $placeholder_index++;
1527 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1529 my $err = $@ || $sth->errstr;
1531 # Statement must finish even if there was an exception.
1532 eval { $sth->finish };
1533 $err = $@ unless $err;
1537 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1539 $self->throw_exception("Unexpected populate error: $err")
1540 if ($i > $#$tuple_status);
1542 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1543 ($tuple_status->[$i][1] || $err),
1544 Data::Dumper::Concise::Dumper({
1545 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1552 sub _dbh_execute_array {
1553 my ($self, $sth, $tuple_status, @extra) = @_;
1555 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1558 sub _dbh_execute_inserts_with_no_binds {
1559 my ($self, $sth, $count) = @_;
1562 my $dbh = $self->_get_dbh;
1563 local $dbh->{RaiseError} = 1;
1564 local $dbh->{PrintError} = 0;
1566 $sth->execute foreach 1..$count;
1570 # Make sure statement is finished even if there was an exception.
1571 eval { $sth->finish };
1572 $exception = $@ unless $exception;
1574 $self->throw_exception($exception) if $exception;
1580 my ($self, $source, @args) = @_;
1582 my $bind_attrs = $self->source_bind_attributes($source);
1584 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1589 my ($self, $source, @args) = @_;
1591 my $bind_attrs = $self->source_bind_attributes($source);
1593 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1596 # We were sent here because the $rs contains a complex search
1597 # which will require a subquery to select the correct rows
1598 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1600 # Generating a single PK column subquery is trivial and supported
1601 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1602 # Look at _multipk_update_delete()
1603 sub _subq_update_delete {
1605 my ($rs, $op, $values) = @_;
1607 my $rsrc = $rs->result_source;
1609 # quick check if we got a sane rs on our hands
1610 my @pcols = $rsrc->_pri_cols;
1612 my $sel = $rs->_resolved_attrs->{select};
1613 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1616 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1618 join ("\x00", sort @$sel )
1620 $self->throw_exception (
1621 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1628 $op eq 'update' ? $values : (),
1629 { $pcols[0] => { -in => $rs->as_query } },
1634 return $self->_multipk_update_delete (@_);
1638 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1639 # resultset update/delete involving subqueries. So by default resort
1640 # to simple (and inefficient) delete_all style per-row opearations,
1641 # while allowing specific storages to override this with a faster
1644 sub _multipk_update_delete {
1645 return shift->_per_row_update_delete (@_);
1648 # This is the default loop used to delete/update rows for multi PK
1649 # resultsets, and used by mysql exclusively (because it can't do anything
1652 # We do not use $row->$op style queries, because resultset update/delete
1653 # is not expected to cascade (this is what delete_all/update_all is for).
1655 # There should be no race conditions as the entire operation is rolled
1658 sub _per_row_update_delete {
1660 my ($rs, $op, $values) = @_;
1662 my $rsrc = $rs->result_source;
1663 my @pcols = $rsrc->_pri_cols;
1665 my $guard = $self->txn_scope_guard;
1667 # emulate the return value of $sth->execute for non-selects
1668 my $row_cnt = '0E0';
1670 my $subrs_cur = $rs->cursor;
1671 my @all_pk = $subrs_cur->all;
1672 for my $pks ( @all_pk) {
1675 for my $i (0.. $#pcols) {
1676 $cond->{$pcols[$i]} = $pks->[$i];
1681 $op eq 'update' ? $values : (),
1696 # localization is neccessary as
1697 # 1) there is no infrastructure to pass this around before SQLA2
1698 # 2) _select_args sets it and _prep_for_execute consumes it
1699 my $sql_maker = $self->sql_maker;
1700 local $sql_maker->{_dbic_rs_attrs};
1702 return $self->_execute($self->_select_args(@_));
1705 sub _select_args_to_query {
1708 # localization is neccessary as
1709 # 1) there is no infrastructure to pass this around before SQLA2
1710 # 2) _select_args sets it and _prep_for_execute consumes it
1711 my $sql_maker = $self->sql_maker;
1712 local $sql_maker->{_dbic_rs_attrs};
1714 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1715 # = $self->_select_args($ident, $select, $cond, $attrs);
1716 my ($op, $bind, $ident, $bind_attrs, @args) =
1717 $self->_select_args(@_);
1719 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1720 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1721 $prepared_bind ||= [];
1724 ? ($sql, $prepared_bind, $bind_attrs)
1725 : \[ "($sql)", @$prepared_bind ]
1730 my ($self, $ident, $select, $where, $attrs) = @_;
1732 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1734 my $sql_maker = $self->sql_maker;
1735 $sql_maker->{_dbic_rs_attrs} = {
1740 $rs_alias && $alias2source->{$rs_alias}
1741 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1746 # calculate bind_attrs before possible $ident mangling
1747 my $bind_attrs = {};
1748 for my $alias (keys %$alias2source) {
1749 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1750 for my $col (keys %$bindtypes) {
1752 my $fqcn = join ('.', $alias, $col);
1753 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1755 # Unqialified column names are nice, but at the same time can be
1756 # rather ambiguous. What we do here is basically go along with
1757 # the loop, adding an unqualified column slot to $bind_attrs,
1758 # alongside the fully qualified name. As soon as we encounter
1759 # another column by that name (which would imply another table)
1760 # we unset the unqualified slot and never add any info to it
1761 # to avoid erroneous type binding. If this happens the users
1762 # only choice will be to fully qualify his column name
1764 if (exists $bind_attrs->{$col}) {
1765 $bind_attrs->{$col} = {};
1768 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1775 $attrs->{software_limit}
1777 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1779 $attrs->{software_limit} = 1;
1782 $self->throw_exception("rows attribute must be positive if present")
1783 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1785 # MySQL actually recommends this approach. I cringe.
1786 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1791 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1792 # storage, unless software limit was requested
1795 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1797 # limited prefetch with RNO subqueries
1801 $sql_maker->limit_dialect eq 'RowNumberOver'
1803 $attrs->{_prefetch_select}
1805 @{$attrs->{_prefetch_select}}
1809 ( $attrs->{group_by}
1811 @{$attrs->{group_by}}
1813 $attrs->{_prefetch_select}
1815 @{$attrs->{_prefetch_select}}
1818 ($ident, $select, $where, $attrs)
1819 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1823 ($attrs->{rows} || $attrs->{offset})
1825 $sql_maker->limit_dialect eq 'RowNumberOver'
1827 (ref $ident eq 'ARRAY' && @$ident > 1) # indicates a join
1829 scalar $self->_parse_order_by ($attrs->{order_by})
1831 # the RNO limit dialect above mangles the SQL such that the join gets lost
1832 # wrap a subquery here
1834 push @limit, delete @{$attrs}{qw/rows offset/};
1836 my $subq = $self->_select_args_to_query (
1844 -alias => $attrs->{alias},
1845 -source_handle => $ident->[0]{-source_handle},
1846 $attrs->{alias} => $subq,
1849 # all part of the subquery now
1850 delete @{$attrs}{qw/order_by group_by having/};
1854 elsif (! $attrs->{software_limit} ) {
1855 push @limit, $attrs->{rows}, $attrs->{offset};
1858 # try to simplify the joinmap further (prune unreferenced type-single joins)
1859 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1862 # This would be the point to deflate anything found in $where
1863 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1864 # expect a row object. And all we have is a resultsource (it is trivial
1865 # to extract deflator coderefs via $alias2source above).
1867 # I don't see a way forward other than changing the way deflators are
1868 # invoked, and that's just bad...
1872 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1873 (qw/order_by group_by having/ )
1876 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1879 # Returns a counting SELECT for a simple count
1880 # query. Abstracted so that a storage could override
1881 # this to { count => 'firstcol' } or whatever makes
1882 # sense as a performance optimization
1884 #my ($self, $source, $rs_attrs) = @_;
1885 return { count => '*' };
1888 # Returns a SELECT which will end up in the subselect
1889 # There may or may not be a group_by, as the subquery
1890 # might have been called to accomodate a limit
1892 # Most databases would be happy with whatever ends up
1893 # here, but some choke in various ways.
1895 sub _subq_count_select {
1896 my ($self, $source, $rs_attrs) = @_;
1898 if (my $groupby = $rs_attrs->{group_by}) {
1900 my $avail_columns = $self->_resolve_column_info ($rs_attrs->{from});
1903 for my $sel (@{$rs_attrs->{select}}) {
1904 if (ref $sel eq 'HASH' and $sel->{-as}) {
1905 $sel_index->{$sel->{-as}} = $sel;
1910 for my $g_part (@$groupby) {
1911 if (ref $g_part or $avail_columns->{$g_part}) {
1912 push @selection, $g_part;
1914 elsif ($sel_index->{$g_part}) {
1915 push @selection, $sel_index->{$g_part};
1918 $self->throw_exception ("group_by criteria '$g_part' not contained within current resultset source(s)");
1925 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1926 return @pcols ? \@pcols : [ 1 ];
1929 sub source_bind_attributes {
1930 my ($self, $source) = @_;
1932 my $bind_attributes;
1933 foreach my $column ($source->columns) {
1935 my $data_type = $source->column_info($column)->{data_type} || '';
1936 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1940 return $bind_attributes;
1947 =item Arguments: $ident, $select, $condition, $attrs
1951 Handle a SQL select statement.
1957 my ($ident, $select, $condition, $attrs) = @_;
1958 return $self->cursor_class->new($self, \@_, $attrs);
1963 my ($rv, $sth, @bind) = $self->_select(@_);
1964 my @row = $sth->fetchrow_array;
1965 my @nextrow = $sth->fetchrow_array if @row;
1966 if(@row && @nextrow) {
1967 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1969 # Need to call finish() to work round broken DBDs
1978 =item Arguments: $sql
1982 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1987 my ($self, $dbh, $sql) = @_;
1989 # 3 is the if_active parameter which avoids active sth re-use
1990 my $sth = $self->disable_sth_caching
1991 ? $dbh->prepare($sql)
1992 : $dbh->prepare_cached($sql, {}, 3);
1994 # XXX You would think RaiseError would make this impossible,
1995 # but apparently that's not true :(
1996 $self->throw_exception($dbh->errstr) if !$sth;
2002 my ($self, $sql) = @_;
2003 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2006 sub _dbh_columns_info_for {
2007 my ($self, $dbh, $table) = @_;
2009 if ($dbh->can('column_info')) {
2012 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2013 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2015 while ( my $info = $sth->fetchrow_hashref() ){
2017 $column_info{data_type} = $info->{TYPE_NAME};
2018 $column_info{size} = $info->{COLUMN_SIZE};
2019 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2020 $column_info{default_value} = $info->{COLUMN_DEF};
2021 my $col_name = $info->{COLUMN_NAME};
2022 $col_name =~ s/^\"(.*)\"$/$1/;
2024 $result{$col_name} = \%column_info;
2027 return \%result if !$@ && scalar keys %result;
2031 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2033 my @columns = @{$sth->{NAME_lc}};
2034 for my $i ( 0 .. $#columns ){
2036 $column_info{data_type} = $sth->{TYPE}->[$i];
2037 $column_info{size} = $sth->{PRECISION}->[$i];
2038 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2040 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2041 $column_info{data_type} = $1;
2042 $column_info{size} = $2;
2045 $result{$columns[$i]} = \%column_info;
2049 foreach my $col (keys %result) {
2050 my $colinfo = $result{$col};
2051 my $type_num = $colinfo->{data_type};
2053 if(defined $type_num && $dbh->can('type_info')) {
2054 my $type_info = $dbh->type_info($type_num);
2055 $type_name = $type_info->{TYPE_NAME} if $type_info;
2056 $colinfo->{data_type} = $type_name if $type_name;
2063 sub columns_info_for {
2064 my ($self, $table) = @_;
2065 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2068 =head2 last_insert_id
2070 Return the row id of the last insert.
2074 sub _dbh_last_insert_id {
2075 my ($self, $dbh, $source, $col) = @_;
2077 my $id = eval { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2079 return $id if defined $id;
2081 my $class = ref $self;
2082 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2085 sub last_insert_id {
2087 $self->_dbh_last_insert_id ($self->_dbh, @_);
2090 =head2 _native_data_type
2094 =item Arguments: $type_name
2098 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2099 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2100 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2102 The default implementation returns C<undef>, implement in your Storage driver if
2103 you need this functionality.
2105 Should map types from other databases to the native RDBMS type, for example
2106 C<VARCHAR2> to C<VARCHAR>.
2108 Types with modifiers should map to the underlying data type. For example,
2109 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2111 Composite types should map to the container type, for example
2112 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2116 sub _native_data_type {
2117 #my ($self, $data_type) = @_;
2121 # Check if placeholders are supported at all
2122 sub _placeholders_supported {
2124 my $dbh = $self->_get_dbh;
2126 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2127 # but it is inaccurate more often than not
2129 local $dbh->{PrintError} = 0;
2130 local $dbh->{RaiseError} = 1;
2131 $dbh->do('select ?', {}, 1);
2136 # Check if placeholders bound to non-string types throw exceptions
2138 sub _typeless_placeholders_supported {
2140 my $dbh = $self->_get_dbh;
2143 local $dbh->{PrintError} = 0;
2144 local $dbh->{RaiseError} = 1;
2145 # this specifically tests a bind that is NOT a string
2146 $dbh->do('select 1 where 1 = ?', {}, 1);
2153 Returns the database driver name.
2158 shift->_get_dbh->{Driver}->{Name};
2161 =head2 bind_attribute_by_data_type
2163 Given a datatype from column info, returns a database specific bind
2164 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2165 let the database planner just handle it.
2167 Generally only needed for special case column types, like bytea in postgres.
2171 sub bind_attribute_by_data_type {
2175 =head2 is_datatype_numeric
2177 Given a datatype from column_info, returns a boolean value indicating if
2178 the current RDBMS considers it a numeric value. This controls how
2179 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2180 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2181 be performed instead of the usual C<eq>.
2185 sub is_datatype_numeric {
2186 my ($self, $dt) = @_;
2188 return 0 unless $dt;
2190 return $dt =~ /^ (?:
2191 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2196 =head2 create_ddl_dir
2200 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2204 Creates a SQL file based on the Schema, for each of the specified
2205 database engines in C<\@databases> in the given directory.
2206 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2208 Given a previous version number, this will also create a file containing
2209 the ALTER TABLE statements to transform the previous schema into the
2210 current one. Note that these statements may contain C<DROP TABLE> or
2211 C<DROP COLUMN> statements that can potentially destroy data.
2213 The file names are created using the C<ddl_filename> method below, please
2214 override this method in your schema if you would like a different file
2215 name format. For the ALTER file, the same format is used, replacing
2216 $version in the name with "$preversion-$version".
2218 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2219 The most common value for this would be C<< { add_drop_table => 1 } >>
2220 to have the SQL produced include a C<DROP TABLE> statement for each table
2221 created. For quoting purposes supply C<quote_table_names> and
2222 C<quote_field_names>.
2224 If no arguments are passed, then the following default values are assumed:
2228 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2230 =item version - $schema->schema_version
2232 =item directory - './'
2234 =item preversion - <none>
2238 By default, C<\%sqlt_args> will have
2240 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2242 merged with the hash passed in. To disable any of those features, pass in a
2243 hashref like the following
2245 { ignore_constraint_names => 0, # ... other options }
2248 WARNING: You are strongly advised to check all SQL files created, before applying
2253 sub create_ddl_dir {
2254 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2256 if(!$dir || !-d $dir) {
2257 carp "No directory given, using ./\n";
2260 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2261 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2263 my $schema_version = $schema->schema_version || '1.x';
2264 $version ||= $schema_version;
2267 add_drop_table => 1,
2268 ignore_constraint_names => 1,
2269 ignore_index_names => 1,
2273 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2274 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2277 my $sqlt = SQL::Translator->new( $sqltargs );
2279 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2280 my $sqlt_schema = $sqlt->translate({ data => $schema })
2281 or $self->throw_exception ($sqlt->error);
2283 foreach my $db (@$databases) {
2285 $sqlt->{schema} = $sqlt_schema;
2286 $sqlt->producer($db);
2289 my $filename = $schema->ddl_filename($db, $version, $dir);
2290 if (-e $filename && ($version eq $schema_version )) {
2291 # if we are dumping the current version, overwrite the DDL
2292 carp "Overwriting existing DDL file - $filename";
2296 my $output = $sqlt->translate;
2298 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2301 if(!open($file, ">$filename")) {
2302 $self->throw_exception("Can't open $filename for writing ($!)");
2305 print $file $output;
2308 next unless ($preversion);
2310 require SQL::Translator::Diff;
2312 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2313 if(!-e $prefilename) {
2314 carp("No previous schema file found ($prefilename)");
2318 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2320 carp("Overwriting existing diff file - $difffile");
2326 my $t = SQL::Translator->new($sqltargs);
2331 or $self->throw_exception ($t->error);
2333 my $out = $t->translate( $prefilename )
2334 or $self->throw_exception ($t->error);
2336 $source_schema = $t->schema;
2338 $source_schema->name( $prefilename )
2339 unless ( $source_schema->name );
2342 # The "new" style of producers have sane normalization and can support
2343 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2344 # And we have to diff parsed SQL against parsed SQL.
2345 my $dest_schema = $sqlt_schema;
2347 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2348 my $t = SQL::Translator->new($sqltargs);
2353 or $self->throw_exception ($t->error);
2355 my $out = $t->translate( $filename )
2356 or $self->throw_exception ($t->error);
2358 $dest_schema = $t->schema;
2360 $dest_schema->name( $filename )
2361 unless $dest_schema->name;
2364 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2368 if(!open $file, ">$difffile") {
2369 $self->throw_exception("Can't write to $difffile ($!)");
2377 =head2 deployment_statements
2381 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2385 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2387 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2388 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2390 C<$directory> is used to return statements from files in a previously created
2391 L</create_ddl_dir> directory and is optional. The filenames are constructed
2392 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2394 If no C<$directory> is specified then the statements are constructed on the
2395 fly using L<SQL::Translator> and C<$version> is ignored.
2397 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2401 sub deployment_statements {
2402 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2403 $type ||= $self->sqlt_type;
2404 $version ||= $schema->schema_version || '1.x';
2406 my $filename = $schema->ddl_filename($type, $version, $dir);
2410 open($file, "<$filename")
2411 or $self->throw_exception("Can't open $filename ($!)");
2414 return join('', @rows);
2417 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2418 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2421 # sources needs to be a parser arg, but for simplicty allow at top level
2423 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2424 if exists $sqltargs->{sources};
2426 my $tr = SQL::Translator->new(
2427 producer => "SQL::Translator::Producer::${type}",
2429 parser => 'SQL::Translator::Parser::DBIx::Class',
2436 @ret = $tr->translate;
2439 $ret[0] = $tr->translate;
2442 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2443 unless (@ret && defined $ret[0]);
2445 return $wa ? @ret : $ret[0];
2449 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2452 return if($line =~ /^--/);
2454 # next if($line =~ /^DROP/m);
2455 return if($line =~ /^BEGIN TRANSACTION/m);
2456 return if($line =~ /^COMMIT/m);
2457 return if $line =~ /^\s+$/; # skip whitespace only
2458 $self->_query_start($line);
2460 # do a dbh_do cycle here, as we need some error checking in
2461 # place (even though we will ignore errors)
2462 $self->dbh_do (sub { $_[1]->do($line) });
2465 carp qq{$@ (running "${line}")};
2467 $self->_query_end($line);
2469 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2470 if (@statements > 1) {
2471 foreach my $statement (@statements) {
2472 $deploy->( $statement );
2475 elsif (@statements == 1) {
2476 foreach my $line ( split(";\n", $statements[0])) {
2482 =head2 datetime_parser
2484 Returns the datetime parser class
2488 sub datetime_parser {
2490 return $self->{datetime_parser} ||= do {
2491 $self->build_datetime_parser(@_);
2495 =head2 datetime_parser_type
2497 Defines (returns) the datetime parser class - currently hardwired to
2498 L<DateTime::Format::MySQL>
2502 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2504 =head2 build_datetime_parser
2506 See L</datetime_parser>
2510 sub build_datetime_parser {
2512 my $type = $self->datetime_parser_type(@_);
2513 $self->ensure_class_loaded ($type);
2518 =head2 is_replicating
2520 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2521 replicate from a master database. Default is undef, which is the result
2522 returned by databases that don't support replication.
2526 sub is_replicating {
2531 =head2 lag_behind_master
2533 Returns a number that represents a certain amount of lag behind a master db
2534 when a given storage is replicating. The number is database dependent, but
2535 starts at zero and increases with the amount of lag. Default in undef
2539 sub lag_behind_master {
2543 =head2 relname_to_table_alias
2547 =item Arguments: $relname, $join_count
2551 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2554 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2555 way these aliases are named.
2557 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2558 otherwise C<"$relname">.
2562 sub relname_to_table_alias {
2563 my ($self, $relname, $join_count) = @_;
2565 my $alias = ($join_count && $join_count > 1 ?
2566 join('_', $relname, $join_count) : $relname);
2574 $self->_verify_pid if $self->_dbh;
2576 # some databases need this to stop spewing warnings
2577 if (my $dbh = $self->_dbh) {
2580 %{ $dbh->{CachedKids} } = ();
2592 =head2 DBIx::Class and AutoCommit
2594 DBIx::Class can do some wonderful magic with handling exceptions,
2595 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2596 (the default) combined with C<txn_do> for transaction support.
2598 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2599 in an assumed transaction between commits, and you're telling us you'd
2600 like to manage that manually. A lot of the magic protections offered by
2601 this module will go away. We can't protect you from exceptions due to database
2602 disconnects because we don't know anything about how to restart your
2603 transactions. You're on your own for handling all sorts of exceptional
2604 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2610 Matt S. Trout <mst@shadowcatsystems.co.uk>
2612 Andy Grundman <andy@hybridized.org>
2616 You may distribute this code under the same terms as Perl itself.