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 # (dsn may not be supplied at all if all we do is make a mock-schema)
954 my $dsn = $self->_dbi_connect_info->[0] || '';
955 ($driver) = $dsn =~ /dbi:([^:]+):/i;
960 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
961 if ($self->load_optional_class($storage_class)) {
962 mro::set_mro($storage_class, 'c3');
963 bless $self, $storage_class;
969 $self->_driver_determined(1);
971 $self->_init; # run driver-specific initializations
973 $self->_run_connection_actions
974 if !$started_connected && defined $self->_dbh;
978 sub _do_connection_actions {
980 my $method_prefix = shift;
983 if (not ref($call)) {
984 my $method = $method_prefix . $call;
986 } elsif (ref($call) eq 'CODE') {
988 } elsif (ref($call) eq 'ARRAY') {
989 if (ref($call->[0]) ne 'ARRAY') {
990 $self->_do_connection_actions($method_prefix, $_) for @$call;
992 $self->_do_connection_actions($method_prefix, @$_) for @$call;
995 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1001 sub connect_call_do_sql {
1003 $self->_do_query(@_);
1006 sub disconnect_call_do_sql {
1008 $self->_do_query(@_);
1011 # override in db-specific backend when necessary
1012 sub connect_call_datetime_setup { 1 }
1015 my ($self, $action) = @_;
1017 if (ref $action eq 'CODE') {
1018 $action = $action->($self);
1019 $self->_do_query($_) foreach @$action;
1022 # Most debuggers expect ($sql, @bind), so we need to exclude
1023 # the attribute hash which is the second argument to $dbh->do
1024 # furthermore the bind values are usually to be presented
1025 # as named arrayref pairs, so wrap those here too
1026 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1027 my $sql = shift @do_args;
1028 my $attrs = shift @do_args;
1029 my @bind = map { [ undef, $_ ] } @do_args;
1031 $self->_query_start($sql, @bind);
1032 $self->_get_dbh->do($sql, $attrs, @do_args);
1033 $self->_query_end($sql, @bind);
1040 my ($self, @info) = @_;
1042 $self->throw_exception("You failed to provide any connection info")
1045 my ($old_connect_via, $dbh);
1047 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1048 $old_connect_via = $DBI::connect_via;
1049 $DBI::connect_via = 'connect';
1053 if(ref $info[0] eq 'CODE') {
1054 $dbh = $info[0]->();
1057 $dbh = DBI->connect(@info);
1060 if($dbh && !$self->unsafe) {
1061 my $weak_self = $self;
1062 Scalar::Util::weaken($weak_self);
1063 $dbh->{HandleError} = sub {
1065 $weak_self->throw_exception("DBI Exception: $_[0]");
1068 # the handler may be invoked by something totally out of
1070 croak ("DBI Exception: $_[0]");
1073 $dbh->{ShowErrorStatement} = 1;
1074 $dbh->{RaiseError} = 1;
1075 $dbh->{PrintError} = 0;
1079 $DBI::connect_via = $old_connect_via if $old_connect_via;
1081 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1084 $self->_dbh_autocommit($dbh->{AutoCommit});
1090 my ($self, $name) = @_;
1092 $name = $self->_svp_generate_name
1093 unless defined $name;
1095 $self->throw_exception ("You can't use savepoints outside a transaction")
1096 if $self->{transaction_depth} == 0;
1098 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1099 unless $self->can('_svp_begin');
1101 push @{ $self->{savepoints} }, $name;
1103 $self->debugobj->svp_begin($name) if $self->debug;
1105 return $self->_svp_begin($name);
1109 my ($self, $name) = @_;
1111 $self->throw_exception ("You can't use savepoints outside a transaction")
1112 if $self->{transaction_depth} == 0;
1114 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1115 unless $self->can('_svp_release');
1117 if (defined $name) {
1118 $self->throw_exception ("Savepoint '$name' does not exist")
1119 unless grep { $_ eq $name } @{ $self->{savepoints} };
1121 # Dig through the stack until we find the one we are releasing. This keeps
1122 # the stack up to date.
1125 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1127 $name = pop @{ $self->{savepoints} };
1130 $self->debugobj->svp_release($name) if $self->debug;
1132 return $self->_svp_release($name);
1136 my ($self, $name) = @_;
1138 $self->throw_exception ("You can't use savepoints outside a transaction")
1139 if $self->{transaction_depth} == 0;
1141 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1142 unless $self->can('_svp_rollback');
1144 if (defined $name) {
1145 # If they passed us a name, verify that it exists in the stack
1146 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1147 $self->throw_exception("Savepoint '$name' does not exist!");
1150 # Dig through the stack until we find the one we are releasing. This keeps
1151 # the stack up to date.
1152 while(my $s = pop(@{ $self->{savepoints} })) {
1153 last if($s eq $name);
1155 # Add the savepoint back to the stack, as a rollback doesn't remove the
1156 # named savepoint, only everything after it.
1157 push(@{ $self->{savepoints} }, $name);
1159 # We'll assume they want to rollback to the last savepoint
1160 $name = $self->{savepoints}->[-1];
1163 $self->debugobj->svp_rollback($name) if $self->debug;
1165 return $self->_svp_rollback($name);
1168 sub _svp_generate_name {
1171 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1177 # this means we have not yet connected and do not know the AC status
1178 # (e.g. coderef $dbh)
1179 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1181 if($self->{transaction_depth} == 0) {
1182 $self->debugobj->txn_begin()
1184 $self->_dbh_begin_work;
1186 elsif ($self->auto_savepoint) {
1189 $self->{transaction_depth}++;
1192 sub _dbh_begin_work {
1195 # if the user is utilizing txn_do - good for him, otherwise we need to
1196 # ensure that the $dbh is healthy on BEGIN.
1197 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1198 # will be replaced by a failure of begin_work itself (which will be
1199 # then retried on reconnect)
1200 if ($self->{_in_dbh_do}) {
1201 $self->_dbh->begin_work;
1203 $self->dbh_do(sub { $_[1]->begin_work });
1209 if ($self->{transaction_depth} == 1) {
1210 $self->debugobj->txn_commit()
1213 $self->{transaction_depth} = 0
1214 if $self->_dbh_autocommit;
1216 elsif($self->{transaction_depth} > 1) {
1217 $self->{transaction_depth}--;
1219 if $self->auto_savepoint;
1225 my $dbh = $self->_dbh
1226 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1232 my $dbh = $self->_dbh;
1234 if ($self->{transaction_depth} == 1) {
1235 $self->debugobj->txn_rollback()
1237 $self->{transaction_depth} = 0
1238 if $self->_dbh_autocommit;
1239 $self->_dbh_rollback;
1241 elsif($self->{transaction_depth} > 1) {
1242 $self->{transaction_depth}--;
1243 if ($self->auto_savepoint) {
1244 $self->svp_rollback;
1249 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1254 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1255 $error =~ /$exception_class/ and $self->throw_exception($error);
1256 # ensure that a failed rollback resets the transaction depth
1257 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1258 $self->throw_exception($error);
1264 my $dbh = $self->_dbh
1265 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1269 # This used to be the top-half of _execute. It was split out to make it
1270 # easier to override in NoBindVars without duping the rest. It takes up
1271 # all of _execute's args, and emits $sql, @bind.
1272 sub _prep_for_execute {
1273 my ($self, $op, $extra_bind, $ident, $args) = @_;
1275 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1276 $ident = $ident->from();
1279 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1282 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1284 return ($sql, \@bind);
1288 sub _fix_bind_params {
1289 my ($self, @bind) = @_;
1291 ### Turn @bind from something like this:
1292 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1294 ### ( "'1'", "'1'", "'3'" )
1297 if ( defined( $_ && $_->[1] ) ) {
1298 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1305 my ( $self, $sql, @bind ) = @_;
1307 if ( $self->debug ) {
1308 @bind = $self->_fix_bind_params(@bind);
1310 $self->debugobj->query_start( $sql, @bind );
1315 my ( $self, $sql, @bind ) = @_;
1317 if ( $self->debug ) {
1318 @bind = $self->_fix_bind_params(@bind);
1319 $self->debugobj->query_end( $sql, @bind );
1324 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1326 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1328 $self->_query_start( $sql, @$bind );
1330 my $sth = $self->sth($sql,$op);
1332 my $placeholder_index = 1;
1334 foreach my $bound (@$bind) {
1335 my $attributes = {};
1336 my($column_name, @data) = @$bound;
1338 if ($bind_attributes) {
1339 $attributes = $bind_attributes->{$column_name}
1340 if defined $bind_attributes->{$column_name};
1343 foreach my $data (@data) {
1344 my $ref = ref $data;
1345 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1347 $sth->bind_param($placeholder_index, $data, $attributes);
1348 $placeholder_index++;
1352 # Can this fail without throwing an exception anyways???
1353 my $rv = $sth->execute();
1354 $self->throw_exception($sth->errstr) if !$rv;
1356 $self->_query_end( $sql, @$bind );
1358 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1363 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1367 my ($self, $source, $to_insert) = @_;
1369 my $ident = $source->from;
1370 my $bind_attributes = $self->source_bind_attributes($source);
1372 my $updated_cols = {};
1374 foreach my $col ( $source->columns ) {
1375 if ( !defined $to_insert->{$col} ) {
1376 my $col_info = $source->column_info($col);
1378 if ( $col_info->{auto_nextval} ) {
1379 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1381 $col_info->{sequence} ||=
1382 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1388 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1390 return $updated_cols;
1393 ## Currently it is assumed that all values passed will be "normal", i.e. not
1394 ## scalar refs, or at least, all the same type as the first set, the statement is
1395 ## only prepped once.
1397 my ($self, $source, $cols, $data) = @_;
1400 @colvalues{@$cols} = (0..$#$cols);
1402 for my $i (0..$#$cols) {
1403 my $first_val = $data->[0][$i];
1404 next unless ref $first_val eq 'SCALAR';
1406 $colvalues{ $cols->[$i] } = $first_val;
1409 # check for bad data and stringify stringifiable objects
1410 my $bad_slice = sub {
1411 my ($msg, $col_idx, $slice_idx) = @_;
1412 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1416 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1417 Data::Dumper::Concise::Dumper({
1418 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1424 for my $datum_idx (0..$#$data) {
1425 my $datum = $data->[$datum_idx];
1427 for my $col_idx (0..$#$cols) {
1428 my $val = $datum->[$col_idx];
1429 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1430 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1432 if ($is_literal_sql) {
1434 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1436 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1437 $bad_slice->("$reftype reference found where literal SQL expected",
1438 $col_idx, $datum_idx);
1440 elsif ($$val ne $$sqla_bind){
1441 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1442 $col_idx, $datum_idx);
1445 elsif (my $reftype = ref $val) {
1447 if (overload::Method($val, '""')) {
1448 $datum->[$col_idx] = "".$val;
1451 $bad_slice->("$reftype reference found where bind expected",
1452 $col_idx, $datum_idx);
1458 my ($sql, $bind) = $self->_prep_for_execute (
1459 'insert', undef, $source, [\%colvalues]
1463 my $empty_bind = 1 if (not @bind) &&
1464 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1466 if ((not @bind) && (not $empty_bind)) {
1467 $self->throw_exception(
1468 'Cannot insert_bulk without support for placeholders'
1472 # neither _execute_array, nor _execute_inserts_with_no_binds are
1473 # atomic (even if _execute _array is a single call). Thus a safety
1475 my $guard = $self->txn_scope_guard unless $self->{transaction_depth} != 0;
1477 $self->_query_start( $sql, ['__BULK__'] );
1478 my $sth = $self->sth($sql);
1481 # bind_param_array doesn't work if there are no binds
1482 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1485 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1486 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1490 $self->_query_end( $sql, ['__BULK__'] );
1493 $guard->commit if $guard;
1495 return (wantarray ? ($rv, $sth, @bind) : $rv);
1498 sub _execute_array {
1499 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1501 ## This must be an arrayref, else nothing works!
1502 my $tuple_status = [];
1504 ## Get the bind_attributes, if any exist
1505 my $bind_attributes = $self->source_bind_attributes($source);
1507 ## Bind the values and execute
1508 my $placeholder_index = 1;
1510 foreach my $bound (@$bind) {
1512 my $attributes = {};
1513 my ($column_name, $data_index) = @$bound;
1515 if( $bind_attributes ) {
1516 $attributes = $bind_attributes->{$column_name}
1517 if defined $bind_attributes->{$column_name};
1520 my @data = map { $_->[$data_index] } @$data;
1522 $sth->bind_param_array(
1525 (%$attributes ? $attributes : ()),
1527 $placeholder_index++;
1531 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1533 my $err = $@ || $sth->errstr;
1535 # Statement must finish even if there was an exception.
1536 eval { $sth->finish };
1537 $err = $@ unless $err;
1541 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1543 $self->throw_exception("Unexpected populate error: $err")
1544 if ($i > $#$tuple_status);
1546 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1547 ($tuple_status->[$i][1] || $err),
1548 Data::Dumper::Concise::Dumper({
1549 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1556 sub _dbh_execute_array {
1557 my ($self, $sth, $tuple_status, @extra) = @_;
1559 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1562 sub _dbh_execute_inserts_with_no_binds {
1563 my ($self, $sth, $count) = @_;
1566 my $dbh = $self->_get_dbh;
1567 local $dbh->{RaiseError} = 1;
1568 local $dbh->{PrintError} = 0;
1570 $sth->execute foreach 1..$count;
1574 # Make sure statement is finished even if there was an exception.
1575 eval { $sth->finish };
1576 $exception = $@ unless $exception;
1578 $self->throw_exception($exception) if $exception;
1584 my ($self, $source, @args) = @_;
1586 my $bind_attrs = $self->source_bind_attributes($source);
1588 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1593 my ($self, $source, @args) = @_;
1595 my $bind_attrs = $self->source_bind_attributes($source);
1597 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1600 # We were sent here because the $rs contains a complex search
1601 # which will require a subquery to select the correct rows
1602 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1604 # Generating a single PK column subquery is trivial and supported
1605 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1606 # Look at _multipk_update_delete()
1607 sub _subq_update_delete {
1609 my ($rs, $op, $values) = @_;
1611 my $rsrc = $rs->result_source;
1613 # quick check if we got a sane rs on our hands
1614 my @pcols = $rsrc->_pri_cols;
1616 my $sel = $rs->_resolved_attrs->{select};
1617 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1620 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1622 join ("\x00", sort @$sel )
1624 $self->throw_exception (
1625 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1632 $op eq 'update' ? $values : (),
1633 { $pcols[0] => { -in => $rs->as_query } },
1638 return $self->_multipk_update_delete (@_);
1642 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1643 # resultset update/delete involving subqueries. So by default resort
1644 # to simple (and inefficient) delete_all style per-row opearations,
1645 # while allowing specific storages to override this with a faster
1648 sub _multipk_update_delete {
1649 return shift->_per_row_update_delete (@_);
1652 # This is the default loop used to delete/update rows for multi PK
1653 # resultsets, and used by mysql exclusively (because it can't do anything
1656 # We do not use $row->$op style queries, because resultset update/delete
1657 # is not expected to cascade (this is what delete_all/update_all is for).
1659 # There should be no race conditions as the entire operation is rolled
1662 sub _per_row_update_delete {
1664 my ($rs, $op, $values) = @_;
1666 my $rsrc = $rs->result_source;
1667 my @pcols = $rsrc->_pri_cols;
1669 my $guard = $self->txn_scope_guard;
1671 # emulate the return value of $sth->execute for non-selects
1672 my $row_cnt = '0E0';
1674 my $subrs_cur = $rs->cursor;
1675 my @all_pk = $subrs_cur->all;
1676 for my $pks ( @all_pk) {
1679 for my $i (0.. $#pcols) {
1680 $cond->{$pcols[$i]} = $pks->[$i];
1685 $op eq 'update' ? $values : (),
1700 # localization is neccessary as
1701 # 1) there is no infrastructure to pass this around before SQLA2
1702 # 2) _select_args sets it and _prep_for_execute consumes it
1703 my $sql_maker = $self->sql_maker;
1704 local $sql_maker->{_dbic_rs_attrs};
1706 return $self->_execute($self->_select_args(@_));
1709 sub _select_args_to_query {
1712 # localization is neccessary as
1713 # 1) there is no infrastructure to pass this around before SQLA2
1714 # 2) _select_args sets it and _prep_for_execute consumes it
1715 my $sql_maker = $self->sql_maker;
1716 local $sql_maker->{_dbic_rs_attrs};
1718 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1719 # = $self->_select_args($ident, $select, $cond, $attrs);
1720 my ($op, $bind, $ident, $bind_attrs, @args) =
1721 $self->_select_args(@_);
1723 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1724 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1725 $prepared_bind ||= [];
1728 ? ($sql, $prepared_bind, $bind_attrs)
1729 : \[ "($sql)", @$prepared_bind ]
1734 my ($self, $ident, $select, $where, $attrs) = @_;
1736 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1738 my $sql_maker = $self->sql_maker;
1739 $sql_maker->{_dbic_rs_attrs} = {
1744 $rs_alias && $alias2source->{$rs_alias}
1745 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1750 # calculate bind_attrs before possible $ident mangling
1751 my $bind_attrs = {};
1752 for my $alias (keys %$alias2source) {
1753 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1754 for my $col (keys %$bindtypes) {
1756 my $fqcn = join ('.', $alias, $col);
1757 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1759 # Unqialified column names are nice, but at the same time can be
1760 # rather ambiguous. What we do here is basically go along with
1761 # the loop, adding an unqualified column slot to $bind_attrs,
1762 # alongside the fully qualified name. As soon as we encounter
1763 # another column by that name (which would imply another table)
1764 # we unset the unqualified slot and never add any info to it
1765 # to avoid erroneous type binding. If this happens the users
1766 # only choice will be to fully qualify his column name
1768 if (exists $bind_attrs->{$col}) {
1769 $bind_attrs->{$col} = {};
1772 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1779 $attrs->{software_limit}
1781 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1783 $attrs->{software_limit} = 1;
1786 $self->throw_exception("rows attribute must be positive if present")
1787 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1789 # MySQL actually recommends this approach. I cringe.
1790 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1795 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1796 # storage, unless software limit was requested
1799 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1801 # limited prefetch with RNO subqueries
1805 $sql_maker->limit_dialect eq 'RowNumberOver'
1807 $attrs->{_prefetch_select}
1809 @{$attrs->{_prefetch_select}}
1813 ( $attrs->{group_by}
1815 @{$attrs->{group_by}}
1817 $attrs->{_prefetch_select}
1819 @{$attrs->{_prefetch_select}}
1822 ($ident, $select, $where, $attrs)
1823 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1827 ($attrs->{rows} || $attrs->{offset})
1829 $sql_maker->limit_dialect eq 'RowNumberOver'
1831 (ref $ident eq 'ARRAY' && @$ident > 1) # indicates a join
1833 scalar $self->_parse_order_by ($attrs->{order_by})
1835 # the RNO limit dialect above mangles the SQL such that the join gets lost
1836 # wrap a subquery here
1838 push @limit, delete @{$attrs}{qw/rows offset/};
1840 my $subq = $self->_select_args_to_query (
1848 -alias => $attrs->{alias},
1849 -source_handle => $ident->[0]{-source_handle},
1850 $attrs->{alias} => $subq,
1853 # all part of the subquery now
1854 delete @{$attrs}{qw/order_by group_by having/};
1858 elsif (! $attrs->{software_limit} ) {
1859 push @limit, $attrs->{rows}, $attrs->{offset};
1862 # try to simplify the joinmap further (prune unreferenced type-single joins)
1863 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1866 # This would be the point to deflate anything found in $where
1867 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1868 # expect a row object. And all we have is a resultsource (it is trivial
1869 # to extract deflator coderefs via $alias2source above).
1871 # I don't see a way forward other than changing the way deflators are
1872 # invoked, and that's just bad...
1876 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1877 (qw/order_by group_by having/ )
1880 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1883 # Returns a counting SELECT for a simple count
1884 # query. Abstracted so that a storage could override
1885 # this to { count => 'firstcol' } or whatever makes
1886 # sense as a performance optimization
1888 #my ($self, $source, $rs_attrs) = @_;
1889 return { count => '*' };
1892 # Returns a SELECT which will end up in the subselect
1893 # There may or may not be a group_by, as the subquery
1894 # might have been called to accomodate a limit
1896 # Most databases would be happy with whatever ends up
1897 # here, but some choke in various ways.
1899 sub _subq_count_select {
1900 my ($self, $source, $rs_attrs) = @_;
1902 if (my $groupby = $rs_attrs->{group_by}) {
1904 my $avail_columns = $self->_resolve_column_info ($rs_attrs->{from});
1907 for my $sel (@{$rs_attrs->{select}}) {
1908 if (ref $sel eq 'HASH' and $sel->{-as}) {
1909 $sel_index->{$sel->{-as}} = $sel;
1914 for my $g_part (@$groupby) {
1915 if (ref $g_part or $avail_columns->{$g_part}) {
1916 push @selection, $g_part;
1918 elsif ($sel_index->{$g_part}) {
1919 push @selection, $sel_index->{$g_part};
1922 $self->throw_exception ("group_by criteria '$g_part' not contained within current resultset source(s)");
1929 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1930 return @pcols ? \@pcols : [ 1 ];
1933 sub source_bind_attributes {
1934 my ($self, $source) = @_;
1936 my $bind_attributes;
1937 foreach my $column ($source->columns) {
1939 my $data_type = $source->column_info($column)->{data_type} || '';
1940 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1944 return $bind_attributes;
1951 =item Arguments: $ident, $select, $condition, $attrs
1955 Handle a SQL select statement.
1961 my ($ident, $select, $condition, $attrs) = @_;
1962 return $self->cursor_class->new($self, \@_, $attrs);
1967 my ($rv, $sth, @bind) = $self->_select(@_);
1968 my @row = $sth->fetchrow_array;
1969 my @nextrow = $sth->fetchrow_array if @row;
1970 if(@row && @nextrow) {
1971 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1973 # Need to call finish() to work round broken DBDs
1982 =item Arguments: $sql
1986 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1991 my ($self, $dbh, $sql) = @_;
1993 # 3 is the if_active parameter which avoids active sth re-use
1994 my $sth = $self->disable_sth_caching
1995 ? $dbh->prepare($sql)
1996 : $dbh->prepare_cached($sql, {}, 3);
1998 # XXX You would think RaiseError would make this impossible,
1999 # but apparently that's not true :(
2000 $self->throw_exception($dbh->errstr) if !$sth;
2006 my ($self, $sql) = @_;
2007 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2010 sub _dbh_columns_info_for {
2011 my ($self, $dbh, $table) = @_;
2013 if ($dbh->can('column_info')) {
2016 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2017 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2019 while ( my $info = $sth->fetchrow_hashref() ){
2021 $column_info{data_type} = $info->{TYPE_NAME};
2022 $column_info{size} = $info->{COLUMN_SIZE};
2023 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2024 $column_info{default_value} = $info->{COLUMN_DEF};
2025 my $col_name = $info->{COLUMN_NAME};
2026 $col_name =~ s/^\"(.*)\"$/$1/;
2028 $result{$col_name} = \%column_info;
2031 return \%result if !$@ && scalar keys %result;
2035 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2037 my @columns = @{$sth->{NAME_lc}};
2038 for my $i ( 0 .. $#columns ){
2040 $column_info{data_type} = $sth->{TYPE}->[$i];
2041 $column_info{size} = $sth->{PRECISION}->[$i];
2042 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2044 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2045 $column_info{data_type} = $1;
2046 $column_info{size} = $2;
2049 $result{$columns[$i]} = \%column_info;
2053 foreach my $col (keys %result) {
2054 my $colinfo = $result{$col};
2055 my $type_num = $colinfo->{data_type};
2057 if(defined $type_num && $dbh->can('type_info')) {
2058 my $type_info = $dbh->type_info($type_num);
2059 $type_name = $type_info->{TYPE_NAME} if $type_info;
2060 $colinfo->{data_type} = $type_name if $type_name;
2067 sub columns_info_for {
2068 my ($self, $table) = @_;
2069 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2072 =head2 last_insert_id
2074 Return the row id of the last insert.
2078 sub _dbh_last_insert_id {
2079 my ($self, $dbh, $source, $col) = @_;
2081 my $id = eval { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2083 return $id if defined $id;
2085 my $class = ref $self;
2086 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2089 sub last_insert_id {
2091 $self->_dbh_last_insert_id ($self->_dbh, @_);
2094 =head2 _native_data_type
2098 =item Arguments: $type_name
2102 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2103 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2104 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2106 The default implementation returns C<undef>, implement in your Storage driver if
2107 you need this functionality.
2109 Should map types from other databases to the native RDBMS type, for example
2110 C<VARCHAR2> to C<VARCHAR>.
2112 Types with modifiers should map to the underlying data type. For example,
2113 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2115 Composite types should map to the container type, for example
2116 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2120 sub _native_data_type {
2121 #my ($self, $data_type) = @_;
2125 # Check if placeholders are supported at all
2126 sub _placeholders_supported {
2128 my $dbh = $self->_get_dbh;
2130 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2131 # but it is inaccurate more often than not
2133 local $dbh->{PrintError} = 0;
2134 local $dbh->{RaiseError} = 1;
2135 $dbh->do('select ?', {}, 1);
2140 # Check if placeholders bound to non-string types throw exceptions
2142 sub _typeless_placeholders_supported {
2144 my $dbh = $self->_get_dbh;
2147 local $dbh->{PrintError} = 0;
2148 local $dbh->{RaiseError} = 1;
2149 # this specifically tests a bind that is NOT a string
2150 $dbh->do('select 1 where 1 = ?', {}, 1);
2157 Returns the database driver name.
2162 shift->_get_dbh->{Driver}->{Name};
2165 =head2 bind_attribute_by_data_type
2167 Given a datatype from column info, returns a database specific bind
2168 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2169 let the database planner just handle it.
2171 Generally only needed for special case column types, like bytea in postgres.
2175 sub bind_attribute_by_data_type {
2179 =head2 is_datatype_numeric
2181 Given a datatype from column_info, returns a boolean value indicating if
2182 the current RDBMS considers it a numeric value. This controls how
2183 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2184 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2185 be performed instead of the usual C<eq>.
2189 sub is_datatype_numeric {
2190 my ($self, $dt) = @_;
2192 return 0 unless $dt;
2194 return $dt =~ /^ (?:
2195 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2200 =head2 create_ddl_dir
2204 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2208 Creates a SQL file based on the Schema, for each of the specified
2209 database engines in C<\@databases> in the given directory.
2210 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2212 Given a previous version number, this will also create a file containing
2213 the ALTER TABLE statements to transform the previous schema into the
2214 current one. Note that these statements may contain C<DROP TABLE> or
2215 C<DROP COLUMN> statements that can potentially destroy data.
2217 The file names are created using the C<ddl_filename> method below, please
2218 override this method in your schema if you would like a different file
2219 name format. For the ALTER file, the same format is used, replacing
2220 $version in the name with "$preversion-$version".
2222 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2223 The most common value for this would be C<< { add_drop_table => 1 } >>
2224 to have the SQL produced include a C<DROP TABLE> statement for each table
2225 created. For quoting purposes supply C<quote_table_names> and
2226 C<quote_field_names>.
2228 If no arguments are passed, then the following default values are assumed:
2232 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2234 =item version - $schema->schema_version
2236 =item directory - './'
2238 =item preversion - <none>
2242 By default, C<\%sqlt_args> will have
2244 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2246 merged with the hash passed in. To disable any of those features, pass in a
2247 hashref like the following
2249 { ignore_constraint_names => 0, # ... other options }
2252 WARNING: You are strongly advised to check all SQL files created, before applying
2257 sub create_ddl_dir {
2258 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2261 carp "No directory given, using ./\n";
2265 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2267 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2268 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2270 my $schema_version = $schema->schema_version || '1.x';
2271 $version ||= $schema_version;
2274 add_drop_table => 1,
2275 ignore_constraint_names => 1,
2276 ignore_index_names => 1,
2280 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2281 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2284 my $sqlt = SQL::Translator->new( $sqltargs );
2286 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2287 my $sqlt_schema = $sqlt->translate({ data => $schema })
2288 or $self->throw_exception ($sqlt->error);
2290 foreach my $db (@$databases) {
2292 $sqlt->{schema} = $sqlt_schema;
2293 $sqlt->producer($db);
2296 my $filename = $schema->ddl_filename($db, $version, $dir);
2297 if (-e $filename && ($version eq $schema_version )) {
2298 # if we are dumping the current version, overwrite the DDL
2299 carp "Overwriting existing DDL file - $filename";
2303 my $output = $sqlt->translate;
2305 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2308 if(!open($file, ">$filename")) {
2309 $self->throw_exception("Can't open $filename for writing ($!)");
2312 print $file $output;
2315 next unless ($preversion);
2317 require SQL::Translator::Diff;
2319 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2320 if(!-e $prefilename) {
2321 carp("No previous schema file found ($prefilename)");
2325 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2327 carp("Overwriting existing diff file - $difffile");
2333 my $t = SQL::Translator->new($sqltargs);
2338 or $self->throw_exception ($t->error);
2340 my $out = $t->translate( $prefilename )
2341 or $self->throw_exception ($t->error);
2343 $source_schema = $t->schema;
2345 $source_schema->name( $prefilename )
2346 unless ( $source_schema->name );
2349 # The "new" style of producers have sane normalization and can support
2350 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2351 # And we have to diff parsed SQL against parsed SQL.
2352 my $dest_schema = $sqlt_schema;
2354 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2355 my $t = SQL::Translator->new($sqltargs);
2360 or $self->throw_exception ($t->error);
2362 my $out = $t->translate( $filename )
2363 or $self->throw_exception ($t->error);
2365 $dest_schema = $t->schema;
2367 $dest_schema->name( $filename )
2368 unless $dest_schema->name;
2371 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2375 if(!open $file, ">$difffile") {
2376 $self->throw_exception("Can't write to $difffile ($!)");
2384 =head2 deployment_statements
2388 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2392 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2394 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2395 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2397 C<$directory> is used to return statements from files in a previously created
2398 L</create_ddl_dir> directory and is optional. The filenames are constructed
2399 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2401 If no C<$directory> is specified then the statements are constructed on the
2402 fly using L<SQL::Translator> and C<$version> is ignored.
2404 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2408 sub deployment_statements {
2409 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2410 $type ||= $self->sqlt_type;
2411 $version ||= $schema->schema_version || '1.x';
2413 my $filename = $schema->ddl_filename($type, $version, $dir);
2417 open($file, "<$filename")
2418 or $self->throw_exception("Can't open $filename ($!)");
2421 return join('', @rows);
2424 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2425 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2428 # sources needs to be a parser arg, but for simplicty allow at top level
2430 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2431 if exists $sqltargs->{sources};
2433 my $tr = SQL::Translator->new(
2434 producer => "SQL::Translator::Producer::${type}",
2436 parser => 'SQL::Translator::Parser::DBIx::Class',
2443 @ret = $tr->translate;
2446 $ret[0] = $tr->translate;
2449 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2450 unless (@ret && defined $ret[0]);
2452 return $wa ? @ret : $ret[0];
2456 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2459 return if($line =~ /^--/);
2461 # next if($line =~ /^DROP/m);
2462 return if($line =~ /^BEGIN TRANSACTION/m);
2463 return if($line =~ /^COMMIT/m);
2464 return if $line =~ /^\s+$/; # skip whitespace only
2465 $self->_query_start($line);
2467 # do a dbh_do cycle here, as we need some error checking in
2468 # place (even though we will ignore errors)
2469 $self->dbh_do (sub { $_[1]->do($line) });
2472 carp qq{$@ (running "${line}")};
2474 $self->_query_end($line);
2476 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2477 if (@statements > 1) {
2478 foreach my $statement (@statements) {
2479 $deploy->( $statement );
2482 elsif (@statements == 1) {
2483 foreach my $line ( split(";\n", $statements[0])) {
2489 =head2 datetime_parser
2491 Returns the datetime parser class
2495 sub datetime_parser {
2497 return $self->{datetime_parser} ||= do {
2498 $self->build_datetime_parser(@_);
2502 =head2 datetime_parser_type
2504 Defines (returns) the datetime parser class - currently hardwired to
2505 L<DateTime::Format::MySQL>
2509 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2511 =head2 build_datetime_parser
2513 See L</datetime_parser>
2517 sub build_datetime_parser {
2519 my $type = $self->datetime_parser_type(@_);
2520 $self->ensure_class_loaded ($type);
2525 =head2 is_replicating
2527 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2528 replicate from a master database. Default is undef, which is the result
2529 returned by databases that don't support replication.
2533 sub is_replicating {
2538 =head2 lag_behind_master
2540 Returns a number that represents a certain amount of lag behind a master db
2541 when a given storage is replicating. The number is database dependent, but
2542 starts at zero and increases with the amount of lag. Default in undef
2546 sub lag_behind_master {
2550 =head2 relname_to_table_alias
2554 =item Arguments: $relname, $join_count
2558 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2561 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2562 way these aliases are named.
2564 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2565 otherwise C<"$relname">.
2569 sub relname_to_table_alias {
2570 my ($self, $relname, $join_count) = @_;
2572 my $alias = ($join_count && $join_count > 1 ?
2573 join('_', $relname, $join_count) : $relname);
2581 $self->_verify_pid if $self->_dbh;
2583 # some databases need this to stop spewing warnings
2584 if (my $dbh = $self->_dbh) {
2587 %{ $dbh->{CachedKids} } = ();
2599 =head2 DBIx::Class and AutoCommit
2601 DBIx::Class can do some wonderful magic with handling exceptions,
2602 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2603 (the default) combined with C<txn_do> for transaction support.
2605 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2606 in an assumed transaction between commits, and you're telling us you'd
2607 like to manage that manually. A lot of the magic protections offered by
2608 this module will go away. We can't protect you from exceptions due to database
2609 disconnects because we don't know anything about how to restart your
2610 transactions. You're on your own for handling all sorts of exceptional
2611 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2617 Matt S. Trout <mst@shadowcatsystems.co.uk>
2619 Andy Grundman <andy@hybridized.org>
2623 You may distribute this code under the same terms as Perl itself.