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/
55 for my $meth (@rdbms_specific_methods) {
57 my $orig = __PACKAGE__->can ($meth)
61 no warnings qw/redefine/;
62 *{__PACKAGE__ ."::$meth"} = Sub::Name::subname $meth => sub {
63 if (not $_[0]->_driver_determined) {
64 $_[0]->_determine_driver;
65 goto $_[0]->can($meth);
74 DBIx::Class::Storage::DBI - DBI storage handler
78 my $schema = MySchema->connect('dbi:SQLite:my.db');
80 $schema->storage->debug(1);
82 my @stuff = $schema->storage->dbh_do(
84 my ($storage, $dbh, @args) = @_;
85 $dbh->do("DROP TABLE authors");
90 $schema->resultset('Book')->search({
91 written_on => $schema->storage->datetime_parser(DateTime->now)
96 This class represents the connection to an RDBMS via L<DBI>. See
97 L<DBIx::Class::Storage> for general information. This pod only
98 documents DBI-specific methods and behaviors.
105 my $new = shift->next::method(@_);
107 $new->transaction_depth(0);
108 $new->_sql_maker_opts({});
109 $new->{savepoints} = [];
110 $new->{_in_dbh_do} = 0;
111 $new->{_dbh_gen} = 0;
118 This method is normally called by L<DBIx::Class::Schema/connection>, which
119 encapsulates its argument list in an arrayref before passing them here.
121 The argument list may contain:
127 The same 4-element argument set one would normally pass to
128 L<DBI/connect>, optionally followed by
129 L<extra attributes|/DBIx::Class specific connection attributes>
130 recognized by DBIx::Class:
132 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
136 A single code reference which returns a connected
137 L<DBI database handle|DBI/connect> optionally followed by
138 L<extra attributes|/DBIx::Class specific connection attributes> recognized
141 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
145 A single hashref with all the attributes and the dsn/user/password
148 $connect_info_args = [{
156 $connect_info_args = [{
157 dbh_maker => sub { DBI->connect (...) },
162 This is particularly useful for L<Catalyst> based applications, allowing the
163 following config (L<Config::General> style):
168 dsn dbi:mysql:database=test
175 The C<dsn>/C<user>/C<password> combination can be substituted by the
176 C<dbh_maker> key whose value is a coderef that returns a connected
177 L<DBI database handle|DBI/connect>
181 Please note that the L<DBI> docs recommend that you always explicitly
182 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
183 recommends that it be set to I<1>, and that you perform transactions
184 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
185 to I<1> if you do not do explicitly set it to zero. This is the default
186 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
188 =head3 DBIx::Class specific connection attributes
190 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
191 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
192 the following connection options. These options can be mixed in with your other
193 L<DBI> connection attributes, or placed in a seperate hashref
194 (C<\%extra_attributes>) as shown above.
196 Every time C<connect_info> is invoked, any previous settings for
197 these options will be cleared before setting the new ones, regardless of
198 whether any options are specified in the new C<connect_info>.
205 Specifies things to do immediately after connecting or re-connecting to
206 the database. Its value may contain:
212 This contains one SQL statement to execute.
214 =item an array reference
216 This contains SQL statements to execute in order. Each element contains
217 a string or a code reference that returns a string.
219 =item a code reference
221 This contains some code to execute. Unlike code references within an
222 array reference, its return value is ignored.
226 =item on_disconnect_do
228 Takes arguments in the same form as L</on_connect_do> and executes them
229 immediately before disconnecting from the database.
231 Note, this only runs if you explicitly call L</disconnect> on the
234 =item on_connect_call
236 A more generalized form of L</on_connect_do> that calls the specified
237 C<connect_call_METHOD> methods in your storage driver.
239 on_connect_do => 'select 1'
243 on_connect_call => [ [ do_sql => 'select 1' ] ]
245 Its values may contain:
251 Will call the C<connect_call_METHOD> method.
253 =item a code reference
255 Will execute C<< $code->($storage) >>
257 =item an array reference
259 Each value can be a method name or code reference.
261 =item an array of arrays
263 For each array, the first item is taken to be the C<connect_call_> method name
264 or code reference, and the rest are parameters to it.
268 Some predefined storage methods you may use:
274 Executes a SQL string or a code reference that returns a SQL string. This is
275 what L</on_connect_do> and L</on_disconnect_do> use.
283 Will execute the scalar as SQL.
287 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
288 attributes hashref and bind values.
290 =item a code reference
292 Will execute C<< $code->($storage) >> and execute the return array refs as
299 Execute any statements necessary to initialize the database session to return
300 and accept datetime/timestamp values used with
301 L<DBIx::Class::InflateColumn::DateTime>.
303 Only necessary for some databases, see your specific storage driver for
304 implementation details.
308 =item on_disconnect_call
310 Takes arguments in the same form as L</on_connect_call> and executes them
311 immediately before disconnecting from the database.
313 Calls the C<disconnect_call_METHOD> methods as opposed to the
314 C<connect_call_METHOD> methods called by L</on_connect_call>.
316 Note, this only runs if you explicitly call L</disconnect> on the
319 =item disable_sth_caching
321 If set to a true value, this option will disable the caching of
322 statement handles via L<DBI/prepare_cached>.
326 Sets the limit dialect. This is useful for JDBC-bridge among others
327 where the remote SQL-dialect cannot be determined by the name of the
328 driver alone. See also L<SQL::Abstract::Limit>.
332 Specifies what characters to use to quote table and column names. If
333 you use this you will want to specify L</name_sep> as well.
335 C<quote_char> expects either a single character, in which case is it
336 is placed on either side of the table/column name, or an arrayref of length
337 2 in which case the table/column name is placed between the elements.
339 For example under MySQL you should use C<< quote_char => '`' >>, and for
340 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
344 This only needs to be used in conjunction with C<quote_char>, and is used to
345 specify the charecter that seperates elements (schemas, tables, columns) from
346 each other. In most cases this is simply a C<.>.
348 The consequences of not supplying this value is that L<SQL::Abstract>
349 will assume DBIx::Class' uses of aliases to be complete column
350 names. The output will look like I<"me.name"> when it should actually
355 This Storage driver normally installs its own C<HandleError>, sets
356 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
357 all database handles, including those supplied by a coderef. It does this
358 so that it can have consistent and useful error behavior.
360 If you set this option to a true value, Storage will not do its usual
361 modifications to the database handle's attributes, and instead relies on
362 the settings in your connect_info DBI options (or the values you set in
363 your connection coderef, in the case that you are connecting via coderef).
365 Note that your custom settings can cause Storage to malfunction,
366 especially if you set a C<HandleError> handler that suppresses exceptions
367 and/or disable C<RaiseError>.
371 If this option is true, L<DBIx::Class> will use savepoints when nesting
372 transactions, making it possible to recover from failure in the inner
373 transaction without having to abort all outer transactions.
377 Use this argument to supply a cursor class other than the default
378 L<DBIx::Class::Storage::DBI::Cursor>.
382 Some real-life examples of arguments to L</connect_info> and
383 L<DBIx::Class::Schema/connect>
385 # Simple SQLite connection
386 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
389 ->connect_info([ sub { DBI->connect(...) } ]);
391 # Connect via subref in hashref
393 dbh_maker => sub { DBI->connect(...) },
394 on_connect_do => 'alter session ...',
397 # A bit more complicated
404 { quote_char => q{"}, name_sep => q{.} },
408 # Equivalent to the previous example
414 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
418 # Same, but with hashref as argument
419 # See parse_connect_info for explanation
422 dsn => 'dbi:Pg:dbname=foo',
424 password => 'my_pg_password',
431 # Subref + DBIx::Class-specific connection options
434 sub { DBI->connect(...) },
438 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
439 disable_sth_caching => 1,
449 my ($self, $info) = @_;
451 return $self->_connect_info if !$info;
453 $self->_connect_info($info); # copy for _connect_info
455 $info = $self->_normalize_connect_info($info)
456 if ref $info eq 'ARRAY';
458 for my $storage_opt (keys %{ $info->{storage_options} }) {
459 my $value = $info->{storage_options}{$storage_opt};
461 $self->$storage_opt($value);
464 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
465 # the new set of options
466 $self->_sql_maker(undef);
467 $self->_sql_maker_opts({});
469 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
470 my $value = $info->{sql_maker_options}{$sql_maker_opt};
472 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
476 %{ $self->_default_dbi_connect_attributes || {} },
477 %{ $info->{attributes} || {} },
480 my @args = @{ $info->{arguments} };
482 $self->_dbi_connect_info([@args,
483 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
485 return $self->_connect_info;
488 sub _normalize_connect_info {
489 my ($self, $info_arg) = @_;
492 my @args = @$info_arg; # take a shallow copy for further mutilation
494 # combine/pre-parse arguments depending on invocation style
497 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
498 %attrs = %{ $args[1] || {} };
501 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
502 %attrs = %{$args[0]};
504 if (my $code = delete $attrs{dbh_maker}) {
507 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
510 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
511 . "to the result of 'dbh_maker'",
513 join (', ', map { "'$_'" } (@ignored) ),
518 @args = delete @attrs{qw/dsn user password/};
521 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
523 % { $args[3] || {} },
524 % { $args[4] || {} },
526 @args = @args[0,1,2];
529 $info{arguments} = \@args;
531 my @storage_opts = grep exists $attrs{$_},
532 @storage_options, 'cursor_class';
534 @{ $info{storage_options} }{@storage_opts} =
535 delete @attrs{@storage_opts} if @storage_opts;
537 my @sql_maker_opts = grep exists $attrs{$_},
538 qw/limit_dialect quote_char name_sep/;
540 @{ $info{sql_maker_options} }{@sql_maker_opts} =
541 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
543 $info{attributes} = \%attrs if %attrs;
548 sub _default_dbi_connect_attributes {
558 This method is deprecated in favour of setting via L</connect_info>.
562 =head2 on_disconnect_do
564 This method is deprecated in favour of setting via L</connect_info>.
568 sub _parse_connect_do {
569 my ($self, $type) = @_;
571 my $val = $self->$type;
572 return () if not defined $val;
577 push @res, [ 'do_sql', $val ];
578 } elsif (ref($val) eq 'CODE') {
580 } elsif (ref($val) eq 'ARRAY') {
581 push @res, map { [ 'do_sql', $_ ] } @$val;
583 $self->throw_exception("Invalid type for $type: ".ref($val));
591 Arguments: ($subref | $method_name), @extra_coderef_args?
593 Execute the given $subref or $method_name using the new exception-based
594 connection management.
596 The first two arguments will be the storage object that C<dbh_do> was called
597 on and a database handle to use. Any additional arguments will be passed
598 verbatim to the called subref as arguments 2 and onwards.
600 Using this (instead of $self->_dbh or $self->dbh) ensures correct
601 exception handling and reconnection (or failover in future subclasses).
603 Your subref should have no side-effects outside of the database, as
604 there is the potential for your subref to be partially double-executed
605 if the database connection was stale/dysfunctional.
609 my @stuff = $schema->storage->dbh_do(
611 my ($storage, $dbh, @cols) = @_;
612 my $cols = join(q{, }, @cols);
613 $dbh->selectrow_array("SELECT $cols FROM foo");
624 my $dbh = $self->_get_dbh;
626 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
627 || $self->{transaction_depth};
629 local $self->{_in_dbh_do} = 1;
632 my $want_array = wantarray;
637 @result = $self->$code($dbh, @_);
639 elsif(defined $want_array) {
640 $result[0] = $self->$code($dbh, @_);
643 $self->$code($dbh, @_);
647 # ->connected might unset $@ - copy
649 if(!$exception) { return $want_array ? @result : $result[0] }
651 $self->throw_exception($exception) if $self->connected;
653 # We were not connected - reconnect and retry, but let any
654 # exception fall right through this time
655 carp "Retrying $code after catching disconnected exception: $exception"
656 if $ENV{DBIC_DBIRETRY_DEBUG};
657 $self->_populate_dbh;
658 $self->$code($self->_dbh, @_);
661 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
662 # It also informs dbh_do to bypass itself while under the direction of txn_do,
663 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
668 ref $coderef eq 'CODE' or $self->throw_exception
669 ('$coderef must be a CODE reference');
671 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
673 local $self->{_in_dbh_do} = 1;
676 my $want_array = wantarray;
685 @result = $coderef->(@_);
687 elsif(defined $want_array) {
688 $result[0] = $coderef->(@_);
696 # ->connected might unset $@ - copy
698 if(!$exception) { return $want_array ? @result : $result[0] }
700 if($tried++ || $self->connected) {
701 eval { $self->txn_rollback };
702 my $rollback_exception = $@;
703 if($rollback_exception) {
704 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
705 $self->throw_exception($exception) # propagate nested rollback
706 if $rollback_exception =~ /$exception_class/;
708 $self->throw_exception(
709 "Transaction aborted: ${exception}. "
710 . "Rollback failed: ${rollback_exception}"
713 $self->throw_exception($exception)
716 # We were not connected, and was first try - reconnect and retry
718 carp "Retrying $coderef after catching disconnected exception: $exception"
719 if $ENV{DBIC_DBIRETRY_DEBUG};
720 $self->_populate_dbh;
726 Our C<disconnect> method also performs a rollback first if the
727 database is not in C<AutoCommit> mode.
737 push @actions, ( $self->on_disconnect_call || () );
738 push @actions, $self->_parse_connect_do ('on_disconnect_do');
740 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
742 $self->_dbh_rollback unless $self->_dbh_autocommit;
744 $self->_dbh->disconnect;
750 =head2 with_deferred_fk_checks
754 =item Arguments: C<$coderef>
756 =item Return Value: The return value of $coderef
760 Storage specific method to run the code ref with FK checks deferred or
761 in MySQL's case disabled entirely.
765 # Storage subclasses should override this
766 sub with_deferred_fk_checks {
767 my ($self, $sub) = @_;
775 =item Arguments: none
777 =item Return Value: 1|0
781 Verifies that the the current database handle is active and ready to execute
782 an SQL statement (i.e. the connection did not get stale, server is still
783 answering, etc.) This method is used internally by L</dbh>.
789 return 0 unless $self->_seems_connected;
792 local $self->_dbh->{RaiseError} = 1;
797 sub _seems_connected {
800 my $dbh = $self->_dbh
803 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
810 return 0 if !$self->_dbh;
813 return $dbh->FETCH('Active');
819 my $dbh = $self->_dbh or return 0;
824 # handle pid changes correctly
825 # NOTE: assumes $self->_dbh is a valid $dbh
829 return if defined $self->_conn_pid && $self->_conn_pid == $$;
831 $self->_dbh->{InactiveDestroy} = 1;
838 sub ensure_connected {
841 unless ($self->connected) {
842 $self->_populate_dbh;
848 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
849 is guaranteed to be healthy by implicitly calling L</connected>, and if
850 necessary performing a reconnection before returning. Keep in mind that this
851 is very B<expensive> on some database engines. Consider using L<dbh_do>
859 if (not $self->_dbh) {
860 $self->_populate_dbh;
862 $self->ensure_connected;
867 # this is the internal "get dbh or connect (don't check)" method
870 $self->_verify_pid if $self->_dbh;
871 $self->_populate_dbh unless $self->_dbh;
875 sub _sql_maker_args {
880 array_datatypes => 1,
881 limit_dialect => $self->_get_dbh,
882 %{$self->_sql_maker_opts}
888 unless ($self->_sql_maker) {
889 my $sql_maker_class = $self->sql_maker_class;
890 $self->ensure_class_loaded ($sql_maker_class);
891 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
893 return $self->_sql_maker;
896 # nothing to do by default
903 my @info = @{$self->_dbi_connect_info || []};
904 $self->_dbh(undef); # in case ->connected failed we might get sent here
905 $self->_dbh($self->_connect(@info));
907 $self->_conn_pid($$);
908 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
910 $self->_determine_driver;
912 # Always set the transaction depth on connect, since
913 # there is no transaction in progress by definition
914 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
916 $self->_run_connection_actions unless $self->{_in_determine_driver};
919 sub _run_connection_actions {
923 push @actions, ( $self->on_connect_call || () );
924 push @actions, $self->_parse_connect_do ('on_connect_do');
926 $self->_do_connection_actions(connect_call_ => $_) for @actions;
929 sub _determine_driver {
932 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
933 my $started_connected = 0;
934 local $self->{_in_determine_driver} = 1;
936 if (ref($self) eq __PACKAGE__) {
938 if ($self->_dbh) { # we are connected
939 $driver = $self->_dbh->{Driver}{Name};
940 $started_connected = 1;
942 # if connect_info is a CODEREF, we have no choice but to connect
943 if (ref $self->_dbi_connect_info->[0] &&
944 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
945 $self->_populate_dbh;
946 $driver = $self->_dbh->{Driver}{Name};
949 # try to use dsn to not require being connected, the driver may still
950 # force a connection in _rebless to determine version
951 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
955 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
956 if ($self->load_optional_class($storage_class)) {
957 mro::set_mro($storage_class, 'c3');
958 bless $self, $storage_class;
963 $self->_driver_determined(1);
965 $self->_init; # run driver-specific initializations
967 $self->_run_connection_actions
968 if !$started_connected && defined $self->_dbh;
972 sub _do_connection_actions {
974 my $method_prefix = shift;
977 if (not ref($call)) {
978 my $method = $method_prefix . $call;
980 } elsif (ref($call) eq 'CODE') {
982 } elsif (ref($call) eq 'ARRAY') {
983 if (ref($call->[0]) ne 'ARRAY') {
984 $self->_do_connection_actions($method_prefix, $_) for @$call;
986 $self->_do_connection_actions($method_prefix, @$_) for @$call;
989 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
995 sub connect_call_do_sql {
997 $self->_do_query(@_);
1000 sub disconnect_call_do_sql {
1002 $self->_do_query(@_);
1005 # override in db-specific backend when necessary
1006 sub connect_call_datetime_setup { 1 }
1009 my ($self, $action) = @_;
1011 if (ref $action eq 'CODE') {
1012 $action = $action->($self);
1013 $self->_do_query($_) foreach @$action;
1016 # Most debuggers expect ($sql, @bind), so we need to exclude
1017 # the attribute hash which is the second argument to $dbh->do
1018 # furthermore the bind values are usually to be presented
1019 # as named arrayref pairs, so wrap those here too
1020 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1021 my $sql = shift @do_args;
1022 my $attrs = shift @do_args;
1023 my @bind = map { [ undef, $_ ] } @do_args;
1025 $self->_query_start($sql, @bind);
1026 $self->_get_dbh->do($sql, $attrs, @do_args);
1027 $self->_query_end($sql, @bind);
1034 my ($self, @info) = @_;
1036 $self->throw_exception("You failed to provide any connection info")
1039 my ($old_connect_via, $dbh);
1041 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1042 $old_connect_via = $DBI::connect_via;
1043 $DBI::connect_via = 'connect';
1047 if(ref $info[0] eq 'CODE') {
1048 $dbh = $info[0]->();
1051 $dbh = DBI->connect(@info);
1054 if($dbh && !$self->unsafe) {
1055 my $weak_self = $self;
1056 Scalar::Util::weaken($weak_self);
1057 $dbh->{HandleError} = sub {
1059 $weak_self->throw_exception("DBI Exception: $_[0]");
1062 # the handler may be invoked by something totally out of
1064 croak ("DBI Exception: $_[0]");
1067 $dbh->{ShowErrorStatement} = 1;
1068 $dbh->{RaiseError} = 1;
1069 $dbh->{PrintError} = 0;
1073 $DBI::connect_via = $old_connect_via if $old_connect_via;
1075 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1078 $self->_dbh_autocommit($dbh->{AutoCommit});
1084 my ($self, $name) = @_;
1086 $name = $self->_svp_generate_name
1087 unless defined $name;
1089 $self->throw_exception ("You can't use savepoints outside a transaction")
1090 if $self->{transaction_depth} == 0;
1092 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1093 unless $self->can('_svp_begin');
1095 push @{ $self->{savepoints} }, $name;
1097 $self->debugobj->svp_begin($name) if $self->debug;
1099 return $self->_svp_begin($name);
1103 my ($self, $name) = @_;
1105 $self->throw_exception ("You can't use savepoints outside a transaction")
1106 if $self->{transaction_depth} == 0;
1108 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1109 unless $self->can('_svp_release');
1111 if (defined $name) {
1112 $self->throw_exception ("Savepoint '$name' does not exist")
1113 unless grep { $_ eq $name } @{ $self->{savepoints} };
1115 # Dig through the stack until we find the one we are releasing. This keeps
1116 # the stack up to date.
1119 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1121 $name = pop @{ $self->{savepoints} };
1124 $self->debugobj->svp_release($name) if $self->debug;
1126 return $self->_svp_release($name);
1130 my ($self, $name) = @_;
1132 $self->throw_exception ("You can't use savepoints outside a transaction")
1133 if $self->{transaction_depth} == 0;
1135 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1136 unless $self->can('_svp_rollback');
1138 if (defined $name) {
1139 # If they passed us a name, verify that it exists in the stack
1140 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1141 $self->throw_exception("Savepoint '$name' does not exist!");
1144 # Dig through the stack until we find the one we are releasing. This keeps
1145 # the stack up to date.
1146 while(my $s = pop(@{ $self->{savepoints} })) {
1147 last if($s eq $name);
1149 # Add the savepoint back to the stack, as a rollback doesn't remove the
1150 # named savepoint, only everything after it.
1151 push(@{ $self->{savepoints} }, $name);
1153 # We'll assume they want to rollback to the last savepoint
1154 $name = $self->{savepoints}->[-1];
1157 $self->debugobj->svp_rollback($name) if $self->debug;
1159 return $self->_svp_rollback($name);
1162 sub _svp_generate_name {
1165 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1171 # this means we have not yet connected and do not know the AC status
1172 # (e.g. coderef $dbh)
1173 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1175 if($self->{transaction_depth} == 0) {
1176 $self->debugobj->txn_begin()
1178 $self->_dbh_begin_work;
1180 elsif ($self->auto_savepoint) {
1183 $self->{transaction_depth}++;
1186 sub _dbh_begin_work {
1189 # if the user is utilizing txn_do - good for him, otherwise we need to
1190 # ensure that the $dbh is healthy on BEGIN.
1191 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1192 # will be replaced by a failure of begin_work itself (which will be
1193 # then retried on reconnect)
1194 if ($self->{_in_dbh_do}) {
1195 $self->_dbh->begin_work;
1197 $self->dbh_do(sub { $_[1]->begin_work });
1203 if ($self->{transaction_depth} == 1) {
1204 $self->debugobj->txn_commit()
1207 $self->{transaction_depth} = 0
1208 if $self->_dbh_autocommit;
1210 elsif($self->{transaction_depth} > 1) {
1211 $self->{transaction_depth}--;
1213 if $self->auto_savepoint;
1219 my $dbh = $self->_dbh
1220 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1226 my $dbh = $self->_dbh;
1228 if ($self->{transaction_depth} == 1) {
1229 $self->debugobj->txn_rollback()
1231 $self->{transaction_depth} = 0
1232 if $self->_dbh_autocommit;
1233 $self->_dbh_rollback;
1235 elsif($self->{transaction_depth} > 1) {
1236 $self->{transaction_depth}--;
1237 if ($self->auto_savepoint) {
1238 $self->svp_rollback;
1243 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1248 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1249 $error =~ /$exception_class/ and $self->throw_exception($error);
1250 # ensure that a failed rollback resets the transaction depth
1251 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1252 $self->throw_exception($error);
1258 my $dbh = $self->_dbh
1259 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1263 # This used to be the top-half of _execute. It was split out to make it
1264 # easier to override in NoBindVars without duping the rest. It takes up
1265 # all of _execute's args, and emits $sql, @bind.
1266 sub _prep_for_execute {
1267 my ($self, $op, $extra_bind, $ident, $args) = @_;
1269 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1270 $ident = $ident->from();
1273 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1276 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1278 return ($sql, \@bind);
1282 sub _fix_bind_params {
1283 my ($self, @bind) = @_;
1285 ### Turn @bind from something like this:
1286 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1288 ### ( "'1'", "'1'", "'3'" )
1291 if ( defined( $_ && $_->[1] ) ) {
1292 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1299 my ( $self, $sql, @bind ) = @_;
1301 if ( $self->debug ) {
1302 @bind = $self->_fix_bind_params(@bind);
1304 $self->debugobj->query_start( $sql, @bind );
1309 my ( $self, $sql, @bind ) = @_;
1311 if ( $self->debug ) {
1312 @bind = $self->_fix_bind_params(@bind);
1313 $self->debugobj->query_end( $sql, @bind );
1318 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1320 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1322 $self->_query_start( $sql, @$bind );
1324 my $sth = $self->sth($sql,$op);
1326 my $placeholder_index = 1;
1328 foreach my $bound (@$bind) {
1329 my $attributes = {};
1330 my($column_name, @data) = @$bound;
1332 if ($bind_attributes) {
1333 $attributes = $bind_attributes->{$column_name}
1334 if defined $bind_attributes->{$column_name};
1337 foreach my $data (@data) {
1338 my $ref = ref $data;
1339 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1341 $sth->bind_param($placeholder_index, $data, $attributes);
1342 $placeholder_index++;
1346 # Can this fail without throwing an exception anyways???
1347 my $rv = $sth->execute();
1348 $self->throw_exception($sth->errstr) if !$rv;
1350 $self->_query_end( $sql, @$bind );
1352 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1357 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1361 my ($self, $source, $to_insert) = @_;
1363 my $ident = $source->from;
1364 my $bind_attributes = $self->source_bind_attributes($source);
1366 my $updated_cols = {};
1368 foreach my $col ( $source->columns ) {
1369 if ( !defined $to_insert->{$col} ) {
1370 my $col_info = $source->column_info($col);
1372 if ( $col_info->{auto_nextval} ) {
1373 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1375 $col_info->{sequence} ||
1376 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1382 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1384 return $updated_cols;
1387 ## Currently it is assumed that all values passed will be "normal", i.e. not
1388 ## scalar refs, or at least, all the same type as the first set, the statement is
1389 ## only prepped once.
1391 my ($self, $source, $cols, $data) = @_;
1394 @colvalues{@$cols} = (0..$#$cols);
1396 for my $i (0..$#$cols) {
1397 my $first_val = $data->[0][$i];
1398 next unless ref $first_val eq 'SCALAR';
1400 $colvalues{ $cols->[$i] } = $first_val;
1403 # check for bad data and stringify stringifiable objects
1404 my $bad_slice = sub {
1405 my ($msg, $col_idx, $slice_idx) = @_;
1406 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1410 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1411 Data::Dumper::Concise::Dumper({
1412 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1418 for my $datum_idx (0..$#$data) {
1419 my $datum = $data->[$datum_idx];
1421 for my $col_idx (0..$#$cols) {
1422 my $val = $datum->[$col_idx];
1423 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1424 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1426 if ($is_literal_sql) {
1428 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1430 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1431 $bad_slice->("$reftype reference found where literal SQL expected",
1432 $col_idx, $datum_idx);
1434 elsif ($$val ne $$sqla_bind){
1435 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1436 $col_idx, $datum_idx);
1439 elsif (my $reftype = ref $val) {
1441 if (overload::Method($val, '""')) {
1442 $datum->[$col_idx] = "".$val;
1445 $bad_slice->("$reftype reference found where bind expected",
1446 $col_idx, $datum_idx);
1452 my ($sql, $bind) = $self->_prep_for_execute (
1453 'insert', undef, $source, [\%colvalues]
1457 my $empty_bind = 1 if (not @bind) &&
1458 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1460 if ((not @bind) && (not $empty_bind)) {
1461 $self->throw_exception(
1462 'Cannot insert_bulk without support for placeholders'
1466 # neither _execute_array, nor _execute_inserts_with_no_binds are
1467 # atomic (even if _execute _array is a single call). Thus a safety
1469 my $guard = $self->txn_scope_guard unless $self->{transaction_depth} != 0;
1471 $self->_query_start( $sql, ['__BULK__'] );
1472 my $sth = $self->sth($sql);
1475 # bind_param_array doesn't work if there are no binds
1476 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1479 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1480 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1484 $self->_query_end( $sql, ['__BULK__'] );
1487 $guard->commit if $guard;
1489 return (wantarray ? ($rv, $sth, @bind) : $rv);
1492 sub _execute_array {
1493 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1495 ## This must be an arrayref, else nothing works!
1496 my $tuple_status = [];
1498 ## Get the bind_attributes, if any exist
1499 my $bind_attributes = $self->source_bind_attributes($source);
1501 ## Bind the values and execute
1502 my $placeholder_index = 1;
1504 foreach my $bound (@$bind) {
1506 my $attributes = {};
1507 my ($column_name, $data_index) = @$bound;
1509 if( $bind_attributes ) {
1510 $attributes = $bind_attributes->{$column_name}
1511 if defined $bind_attributes->{$column_name};
1514 my @data = map { $_->[$data_index] } @$data;
1516 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1517 $placeholder_index++;
1521 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1523 my $err = $@ || $sth->errstr;
1525 # Statement must finish even if there was an exception.
1526 eval { $sth->finish };
1527 $err = $@ unless $err;
1531 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1533 $self->throw_exception("Unexpected populate error: $err")
1534 if ($i > $#$tuple_status);
1536 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1537 ($tuple_status->[$i][1] || $err),
1538 Data::Dumper::Concise::Dumper({
1539 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1546 sub _dbh_execute_array {
1547 my ($self, $sth, $tuple_status, @extra) = @_;
1549 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1552 sub _dbh_execute_inserts_with_no_binds {
1553 my ($self, $sth, $count) = @_;
1556 my $dbh = $self->_get_dbh;
1557 local $dbh->{RaiseError} = 1;
1558 local $dbh->{PrintError} = 0;
1560 $sth->execute foreach 1..$count;
1564 # Make sure statement is finished even if there was an exception.
1565 eval { $sth->finish };
1566 $exception = $@ unless $exception;
1568 $self->throw_exception($exception) if $exception;
1574 my ($self, $source, @args) = @_;
1576 my $bind_attrs = $self->source_bind_attributes($source);
1578 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1583 my ($self, $source, @args) = @_;
1585 my $bind_attrs = $self->source_bind_attributes($source);
1587 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1590 # We were sent here because the $rs contains a complex search
1591 # which will require a subquery to select the correct rows
1592 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1594 # Generating a single PK column subquery is trivial and supported
1595 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1596 # Look at _multipk_update_delete()
1597 sub _subq_update_delete {
1599 my ($rs, $op, $values) = @_;
1601 my $rsrc = $rs->result_source;
1603 # quick check if we got a sane rs on our hands
1604 my @pcols = $rsrc->primary_columns;
1606 $self->throw_exception (
1608 "You must declare primary key(s) on source '%s' (via set_primary_key) in order to update or delete complex resultsets",
1609 $rsrc->source_name || $rsrc->from
1614 my $sel = $rs->_resolved_attrs->{select};
1615 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1618 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1620 join ("\x00", sort @$sel )
1622 $self->throw_exception (
1623 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1630 $op eq 'update' ? $values : (),
1631 { $pcols[0] => { -in => $rs->as_query } },
1636 return $self->_multipk_update_delete (@_);
1640 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1641 # resultset update/delete involving subqueries. So by default resort
1642 # to simple (and inefficient) delete_all style per-row opearations,
1643 # while allowing specific storages to override this with a faster
1646 sub _multipk_update_delete {
1647 return shift->_per_row_update_delete (@_);
1650 # This is the default loop used to delete/update rows for multi PK
1651 # resultsets, and used by mysql exclusively (because it can't do anything
1654 # We do not use $row->$op style queries, because resultset update/delete
1655 # is not expected to cascade (this is what delete_all/update_all is for).
1657 # There should be no race conditions as the entire operation is rolled
1660 sub _per_row_update_delete {
1662 my ($rs, $op, $values) = @_;
1664 my $rsrc = $rs->result_source;
1665 my @pcols = $rsrc->primary_columns;
1667 my $guard = $self->txn_scope_guard;
1669 # emulate the return value of $sth->execute for non-selects
1670 my $row_cnt = '0E0';
1672 my $subrs_cur = $rs->cursor;
1673 my @all_pk = $subrs_cur->all;
1674 for my $pks ( @all_pk) {
1677 for my $i (0.. $#pcols) {
1678 $cond->{$pcols[$i]} = $pks->[$i];
1683 $op eq 'update' ? $values : (),
1698 # localization is neccessary as
1699 # 1) there is no infrastructure to pass this around before SQLA2
1700 # 2) _select_args sets it and _prep_for_execute consumes it
1701 my $sql_maker = $self->sql_maker;
1702 local $sql_maker->{_dbic_rs_attrs};
1704 return $self->_execute($self->_select_args(@_));
1707 sub _select_args_to_query {
1710 # localization is neccessary as
1711 # 1) there is no infrastructure to pass this around before SQLA2
1712 # 2) _select_args sets it and _prep_for_execute consumes it
1713 my $sql_maker = $self->sql_maker;
1714 local $sql_maker->{_dbic_rs_attrs};
1716 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1717 # = $self->_select_args($ident, $select, $cond, $attrs);
1718 my ($op, $bind, $ident, $bind_attrs, @args) =
1719 $self->_select_args(@_);
1721 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1722 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1723 $prepared_bind ||= [];
1726 ? ($sql, $prepared_bind, $bind_attrs)
1727 : \[ "($sql)", @$prepared_bind ]
1732 my ($self, $ident, $select, $where, $attrs) = @_;
1734 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1736 my $sql_maker = $self->sql_maker;
1737 $sql_maker->{_dbic_rs_attrs} = {
1742 $rs_alias && $alias2source->{$rs_alias}
1743 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1748 # calculate bind_attrs before possible $ident mangling
1749 my $bind_attrs = {};
1750 for my $alias (keys %$alias2source) {
1751 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1752 for my $col (keys %$bindtypes) {
1754 my $fqcn = join ('.', $alias, $col);
1755 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1757 # Unqialified column names are nice, but at the same time can be
1758 # rather ambiguous. What we do here is basically go along with
1759 # the loop, adding an unqualified column slot to $bind_attrs,
1760 # alongside the fully qualified name. As soon as we encounter
1761 # another column by that name (which would imply another table)
1762 # we unset the unqualified slot and never add any info to it
1763 # to avoid erroneous type binding. If this happens the users
1764 # only choice will be to fully qualify his column name
1766 if (exists $bind_attrs->{$col}) {
1767 $bind_attrs->{$col} = {};
1770 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1777 $attrs->{software_limit}
1779 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1781 $attrs->{software_limit} = 1;
1784 $self->throw_exception("rows attribute must be positive if present")
1785 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1787 # MySQL actually recommends this approach. I cringe.
1788 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1793 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
1794 # storage, unless software limit was requested
1797 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1799 # limited prefetch with RNO subqueries
1803 $sql_maker->limit_dialect eq 'RowNumberOver'
1805 $attrs->{_prefetch_select}
1807 @{$attrs->{_prefetch_select}}
1811 ( $attrs->{group_by}
1813 @{$attrs->{group_by}}
1815 $attrs->{_prefetch_select}
1817 @{$attrs->{_prefetch_select}}
1820 ($ident, $select, $where, $attrs)
1821 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1825 ($attrs->{rows} || $attrs->{offset})
1827 $sql_maker->limit_dialect eq 'RowNumberOver'
1829 (ref $ident eq 'ARRAY' && @$ident > 1) # indicates a join
1831 scalar $self->_parse_order_by ($attrs->{order_by})
1833 # the RNO limit dialect above mangles the SQL such that the join gets lost
1834 # wrap a subquery here
1836 push @limit, delete @{$attrs}{qw/rows offset/};
1838 my $subq = $self->_select_args_to_query (
1846 -alias => $attrs->{alias},
1847 -source_handle => $ident->[0]{-source_handle},
1848 $attrs->{alias} => $subq,
1851 # all part of the subquery now
1852 delete @{$attrs}{qw/order_by group_by having/};
1856 elsif (! $attrs->{software_limit} ) {
1857 push @limit, $attrs->{rows}, $attrs->{offset};
1860 # try to simplify the joinmap further (prune unreferenced type-single joins)
1861 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
1864 # This would be the point to deflate anything found in $where
1865 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1866 # expect a row object. And all we have is a resultsource (it is trivial
1867 # to extract deflator coderefs via $alias2source above).
1869 # I don't see a way forward other than changing the way deflators are
1870 # invoked, and that's just bad...
1874 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1875 (qw/order_by group_by having/ )
1878 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1881 # Returns a counting SELECT for a simple count
1882 # query. Abstracted so that a storage could override
1883 # this to { count => 'firstcol' } or whatever makes
1884 # sense as a performance optimization
1886 #my ($self, $source, $rs_attrs) = @_;
1887 return { count => '*' };
1890 # Returns a SELECT which will end up in the subselect
1891 # There may or may not be a group_by, as the subquery
1892 # might have been called to accomodate a limit
1894 # Most databases would be happy with whatever ends up
1895 # here, but some choke in various ways.
1897 sub _subq_count_select {
1898 my ($self, $source, $rs_attrs) = @_;
1899 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1901 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1902 return @pcols ? \@pcols : [ 1 ];
1905 sub source_bind_attributes {
1906 my ($self, $source) = @_;
1908 my $bind_attributes;
1909 foreach my $column ($source->columns) {
1911 my $data_type = $source->column_info($column)->{data_type} || '';
1912 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1916 return $bind_attributes;
1923 =item Arguments: $ident, $select, $condition, $attrs
1927 Handle a SQL select statement.
1933 my ($ident, $select, $condition, $attrs) = @_;
1934 return $self->cursor_class->new($self, \@_, $attrs);
1939 my ($rv, $sth, @bind) = $self->_select(@_);
1940 my @row = $sth->fetchrow_array;
1941 my @nextrow = $sth->fetchrow_array if @row;
1942 if(@row && @nextrow) {
1943 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1945 # Need to call finish() to work round broken DBDs
1954 =item Arguments: $sql
1958 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1963 my ($self, $dbh, $sql) = @_;
1965 # 3 is the if_active parameter which avoids active sth re-use
1966 my $sth = $self->disable_sth_caching
1967 ? $dbh->prepare($sql)
1968 : $dbh->prepare_cached($sql, {}, 3);
1970 # XXX You would think RaiseError would make this impossible,
1971 # but apparently that's not true :(
1972 $self->throw_exception($dbh->errstr) if !$sth;
1978 my ($self, $sql) = @_;
1979 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
1982 sub _dbh_columns_info_for {
1983 my ($self, $dbh, $table) = @_;
1985 if ($dbh->can('column_info')) {
1988 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1989 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1991 while ( my $info = $sth->fetchrow_hashref() ){
1993 $column_info{data_type} = $info->{TYPE_NAME};
1994 $column_info{size} = $info->{COLUMN_SIZE};
1995 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1996 $column_info{default_value} = $info->{COLUMN_DEF};
1997 my $col_name = $info->{COLUMN_NAME};
1998 $col_name =~ s/^\"(.*)\"$/$1/;
2000 $result{$col_name} = \%column_info;
2003 return \%result if !$@ && scalar keys %result;
2007 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2009 my @columns = @{$sth->{NAME_lc}};
2010 for my $i ( 0 .. $#columns ){
2012 $column_info{data_type} = $sth->{TYPE}->[$i];
2013 $column_info{size} = $sth->{PRECISION}->[$i];
2014 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2016 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2017 $column_info{data_type} = $1;
2018 $column_info{size} = $2;
2021 $result{$columns[$i]} = \%column_info;
2025 foreach my $col (keys %result) {
2026 my $colinfo = $result{$col};
2027 my $type_num = $colinfo->{data_type};
2029 if(defined $type_num && $dbh->can('type_info')) {
2030 my $type_info = $dbh->type_info($type_num);
2031 $type_name = $type_info->{TYPE_NAME} if $type_info;
2032 $colinfo->{data_type} = $type_name if $type_name;
2039 sub columns_info_for {
2040 my ($self, $table) = @_;
2041 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2044 =head2 last_insert_id
2046 Return the row id of the last insert.
2050 sub _dbh_last_insert_id {
2051 my ($self, $dbh, $source, $col) = @_;
2053 my $id = eval { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2055 return $id if defined $id;
2057 my $class = ref $self;
2058 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2061 sub last_insert_id {
2063 $self->_dbh_last_insert_id ($self->_dbh, @_);
2066 =head2 _native_data_type
2070 =item Arguments: $type_name
2074 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2075 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2076 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2078 The default implementation returns C<undef>, implement in your Storage driver if
2079 you need this functionality.
2081 Should map types from other databases to the native RDBMS type, for example
2082 C<VARCHAR2> to C<VARCHAR>.
2084 Types with modifiers should map to the underlying data type. For example,
2085 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2087 Composite types should map to the container type, for example
2088 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2092 sub _native_data_type {
2093 #my ($self, $data_type) = @_;
2097 # Check if placeholders are supported at all
2098 sub _placeholders_supported {
2100 my $dbh = $self->_get_dbh;
2102 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2103 # but it is inaccurate more often than not
2105 local $dbh->{PrintError} = 0;
2106 local $dbh->{RaiseError} = 1;
2107 $dbh->do('select ?', {}, 1);
2112 # Check if placeholders bound to non-string types throw exceptions
2114 sub _typeless_placeholders_supported {
2116 my $dbh = $self->_get_dbh;
2119 local $dbh->{PrintError} = 0;
2120 local $dbh->{RaiseError} = 1;
2121 # this specifically tests a bind that is NOT a string
2122 $dbh->do('select 1 where 1 = ?', {}, 1);
2129 Returns the database driver name.
2134 shift->_get_dbh->{Driver}->{Name};
2137 =head2 bind_attribute_by_data_type
2139 Given a datatype from column info, returns a database specific bind
2140 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2141 let the database planner just handle it.
2143 Generally only needed for special case column types, like bytea in postgres.
2147 sub bind_attribute_by_data_type {
2151 =head2 is_datatype_numeric
2153 Given a datatype from column_info, returns a boolean value indicating if
2154 the current RDBMS considers it a numeric value. This controls how
2155 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2156 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2157 be performed instead of the usual C<eq>.
2161 sub is_datatype_numeric {
2162 my ($self, $dt) = @_;
2164 return 0 unless $dt;
2166 return $dt =~ /^ (?:
2167 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2172 =head2 create_ddl_dir
2176 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2180 Creates a SQL file based on the Schema, for each of the specified
2181 database engines in C<\@databases> in the given directory.
2182 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2184 Given a previous version number, this will also create a file containing
2185 the ALTER TABLE statements to transform the previous schema into the
2186 current one. Note that these statements may contain C<DROP TABLE> or
2187 C<DROP COLUMN> statements that can potentially destroy data.
2189 The file names are created using the C<ddl_filename> method below, please
2190 override this method in your schema if you would like a different file
2191 name format. For the ALTER file, the same format is used, replacing
2192 $version in the name with "$preversion-$version".
2194 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2195 The most common value for this would be C<< { add_drop_table => 1 } >>
2196 to have the SQL produced include a C<DROP TABLE> statement for each table
2197 created. For quoting purposes supply C<quote_table_names> and
2198 C<quote_field_names>.
2200 If no arguments are passed, then the following default values are assumed:
2204 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2206 =item version - $schema->schema_version
2208 =item directory - './'
2210 =item preversion - <none>
2214 By default, C<\%sqlt_args> will have
2216 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2218 merged with the hash passed in. To disable any of those features, pass in a
2219 hashref like the following
2221 { ignore_constraint_names => 0, # ... other options }
2224 WARNING: You are strongly advised to check all SQL files created, before applying
2229 sub create_ddl_dir {
2230 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2232 if(!$dir || !-d $dir) {
2233 carp "No directory given, using ./\n";
2236 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2237 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2239 my $schema_version = $schema->schema_version || '1.x';
2240 $version ||= $schema_version;
2243 add_drop_table => 1,
2244 ignore_constraint_names => 1,
2245 ignore_index_names => 1,
2249 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2250 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2253 my $sqlt = SQL::Translator->new( $sqltargs );
2255 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2256 my $sqlt_schema = $sqlt->translate({ data => $schema })
2257 or $self->throw_exception ($sqlt->error);
2259 foreach my $db (@$databases) {
2261 $sqlt->{schema} = $sqlt_schema;
2262 $sqlt->producer($db);
2265 my $filename = $schema->ddl_filename($db, $version, $dir);
2266 if (-e $filename && ($version eq $schema_version )) {
2267 # if we are dumping the current version, overwrite the DDL
2268 carp "Overwriting existing DDL file - $filename";
2272 my $output = $sqlt->translate;
2274 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2277 if(!open($file, ">$filename")) {
2278 $self->throw_exception("Can't open $filename for writing ($!)");
2281 print $file $output;
2284 next unless ($preversion);
2286 require SQL::Translator::Diff;
2288 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2289 if(!-e $prefilename) {
2290 carp("No previous schema file found ($prefilename)");
2294 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2296 carp("Overwriting existing diff file - $difffile");
2302 my $t = SQL::Translator->new($sqltargs);
2307 or $self->throw_exception ($t->error);
2309 my $out = $t->translate( $prefilename )
2310 or $self->throw_exception ($t->error);
2312 $source_schema = $t->schema;
2314 $source_schema->name( $prefilename )
2315 unless ( $source_schema->name );
2318 # The "new" style of producers have sane normalization and can support
2319 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2320 # And we have to diff parsed SQL against parsed SQL.
2321 my $dest_schema = $sqlt_schema;
2323 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2324 my $t = SQL::Translator->new($sqltargs);
2329 or $self->throw_exception ($t->error);
2331 my $out = $t->translate( $filename )
2332 or $self->throw_exception ($t->error);
2334 $dest_schema = $t->schema;
2336 $dest_schema->name( $filename )
2337 unless $dest_schema->name;
2340 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2344 if(!open $file, ">$difffile") {
2345 $self->throw_exception("Can't write to $difffile ($!)");
2353 =head2 deployment_statements
2357 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2361 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2363 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2364 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2366 C<$directory> is used to return statements from files in a previously created
2367 L</create_ddl_dir> directory and is optional. The filenames are constructed
2368 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2370 If no C<$directory> is specified then the statements are constructed on the
2371 fly using L<SQL::Translator> and C<$version> is ignored.
2373 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2377 sub deployment_statements {
2378 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2379 $type ||= $self->sqlt_type;
2380 $version ||= $schema->schema_version || '1.x';
2382 my $filename = $schema->ddl_filename($type, $version, $dir);
2386 open($file, "<$filename")
2387 or $self->throw_exception("Can't open $filename ($!)");
2390 return join('', @rows);
2393 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2394 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2397 # sources needs to be a parser arg, but for simplicty allow at top level
2399 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2400 if exists $sqltargs->{sources};
2402 my $tr = SQL::Translator->new(
2403 producer => "SQL::Translator::Producer::${type}",
2405 parser => 'SQL::Translator::Parser::DBIx::Class',
2412 @ret = $tr->translate;
2415 $ret[0] = $tr->translate;
2418 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2419 unless (@ret && defined $ret[0]);
2421 return $wa ? @ret : $ret[0];
2425 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2428 return if($line =~ /^--/);
2430 # next if($line =~ /^DROP/m);
2431 return if($line =~ /^BEGIN TRANSACTION/m);
2432 return if($line =~ /^COMMIT/m);
2433 return if $line =~ /^\s+$/; # skip whitespace only
2434 $self->_query_start($line);
2436 # do a dbh_do cycle here, as we need some error checking in
2437 # place (even though we will ignore errors)
2438 $self->dbh_do (sub { $_[1]->do($line) });
2441 carp qq{$@ (running "${line}")};
2443 $self->_query_end($line);
2445 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2446 if (@statements > 1) {
2447 foreach my $statement (@statements) {
2448 $deploy->( $statement );
2451 elsif (@statements == 1) {
2452 foreach my $line ( split(";\n", $statements[0])) {
2458 =head2 datetime_parser
2460 Returns the datetime parser class
2464 sub datetime_parser {
2466 return $self->{datetime_parser} ||= do {
2467 $self->build_datetime_parser(@_);
2471 =head2 datetime_parser_type
2473 Defines (returns) the datetime parser class - currently hardwired to
2474 L<DateTime::Format::MySQL>
2478 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2480 =head2 build_datetime_parser
2482 See L</datetime_parser>
2486 sub build_datetime_parser {
2488 my $type = $self->datetime_parser_type(@_);
2489 $self->ensure_class_loaded ($type);
2494 =head2 is_replicating
2496 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2497 replicate from a master database. Default is undef, which is the result
2498 returned by databases that don't support replication.
2502 sub is_replicating {
2507 =head2 lag_behind_master
2509 Returns a number that represents a certain amount of lag behind a master db
2510 when a given storage is replicating. The number is database dependent, but
2511 starts at zero and increases with the amount of lag. Default in undef
2515 sub lag_behind_master {
2519 =head2 relname_to_table_alias
2523 =item Arguments: $relname, $join_count
2527 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2530 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2531 way these aliases are named.
2533 The default behavior is C<"$relname_$join_count" if $join_count > 1>, otherwise
2538 sub relname_to_table_alias {
2539 my ($self, $relname, $join_count) = @_;
2541 my $alias = ($join_count && $join_count > 1 ?
2542 join('_', $relname, $join_count) : $relname);
2550 $self->_verify_pid if $self->_dbh;
2552 # some databases need this to stop spewing warnings
2553 if (my $dbh = $self->_dbh) {
2556 %{ $dbh->{CachedKids} } = ();
2568 =head2 DBIx::Class and AutoCommit
2570 DBIx::Class can do some wonderful magic with handling exceptions,
2571 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2572 (the default) combined with C<txn_do> for transaction support.
2574 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2575 in an assumed transaction between commits, and you're telling us you'd
2576 like to manage that manually. A lot of the magic protections offered by
2577 this module will go away. We can't protect you from exceptions due to database
2578 disconnects because we don't know anything about how to restart your
2579 transactions. You're on your own for handling all sorts of exceptional
2580 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2586 Matt S. Trout <mst@shadowcatsystems.co.uk>
2588 Andy Grundman <andy@hybridized.org>
2592 You may distribute this code under the same terms as Perl itself.