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 DBIx::Class::Carp;
11 use Scalar::Util qw/refaddr weaken reftype blessed/;
12 use List::Util qw/first/;
13 use Sub::Name 'subname';
14 use Context::Preserve 'preserve_context';
17 use Data::Compare (); # no imports!!! guard against insane architecture
20 # default cursor class, overridable in connect_info attributes
21 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
23 __PACKAGE__->mk_group_accessors('inherited' => qw/
24 sql_limit_dialect sql_quote_char sql_name_sep
27 __PACKAGE__->mk_group_accessors('component_class' => qw/sql_maker_class datetime_parser_type/);
29 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
30 __PACKAGE__->datetime_parser_type('DateTime::Format::MySQL'); # historic default
32 __PACKAGE__->sql_name_sep('.');
34 __PACKAGE__->mk_group_accessors('simple' => qw/
35 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
36 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts _dbh_autocommit
37 _perform_autoinc_retrieval _autoinc_supplied_for_op
40 # the values for these accessors are picked out (and deleted) from
41 # the attribute hashref passed to connect_info
42 my @storage_options = qw/
43 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
44 disable_sth_caching unsafe auto_savepoint
46 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
49 # capability definitions, using a 2-tiered accessor system
52 # A driver/user may define _use_X, which blindly without any checks says:
53 # "(do not) use this capability", (use_dbms_capability is an "inherited"
56 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
57 # accessor, which in turn calls _determine_supports_X, and stores the return
58 # in a special slot on the storage object, which is wiped every time a $dbh
59 # reconnection takes place (it is not guaranteed that upon reconnection we
60 # will get the same rdbms version). _determine_supports_X does not need to
61 # exist on a driver, as we ->can for it before calling.
63 my @capabilities = (qw/
65 insert_returning_bound
74 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
75 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
77 # on by default, not strictly a capability (pending rewrite)
78 __PACKAGE__->_use_join_optimizer (1);
79 sub _determine_supports_join_optimizer { 1 };
81 # Each of these methods need _determine_driver called before itself
82 # in order to function reliably. This is a purely DRY optimization
84 # get_(use)_dbms_capability need to be called on the correct Storage
85 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
86 # _determine_supports_X which obv. needs a correct driver as well
87 my @rdbms_specific_methods = qw/
106 with_deferred_fk_checks
108 get_use_dbms_capability
115 for my $meth (@rdbms_specific_methods) {
117 my $orig = __PACKAGE__->can ($meth)
118 or die "$meth is not a ::Storage::DBI method!";
121 no warnings qw/redefine/;
122 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
124 # only fire when invoked on an instance, a valid class-based invocation
125 # would e.g. be setting a default for an inherited accessor
128 ! $_[0]->{_driver_determined}
130 ! $_[0]->{_in_determine_driver}
132 ($_[0]->_dbi_connect_info||[])->[0]
134 $_[0]->_determine_driver;
136 # This for some reason crashes and burns on perl 5.8.1
137 # IFF the method ends up throwing an exception
138 #goto $_[0]->can ($meth);
140 my $cref = $_[0]->can ($meth);
150 $self->{perl_renderer} ||= do {
151 require DBIx::Class::PerlRenderer;
152 DBIx::Class::PerlRenderer->new;
158 DBIx::Class::Storage::DBI - DBI storage handler
162 my $schema = MySchema->connect('dbi:SQLite:my.db');
164 $schema->storage->debug(1);
166 my @stuff = $schema->storage->dbh_do(
168 my ($storage, $dbh, @args) = @_;
169 $dbh->do("DROP TABLE authors");
174 $schema->resultset('Book')->search({
175 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
180 This class represents the connection to an RDBMS via L<DBI>. See
181 L<DBIx::Class::Storage> for general information. This pod only
182 documents DBI-specific methods and behaviors.
189 my $new = shift->next::method(@_);
191 $new->_sql_maker_opts({});
192 $new->_dbh_details({});
193 $new->{_in_do_block} = 0;
195 # read below to see what this does
196 $new->_arm_global_destructor;
201 # This is hack to work around perl shooting stuff in random
202 # order on exit(). If we do not walk the remaining storage
203 # objects in an END block, there is a *small but real* chance
204 # of a fork()ed child to kill the parent's shared DBI handle,
205 # *before perl reaches the DESTROY in this package*
206 # Yes, it is ugly and effective.
207 # Additionally this registry is used by the CLONE method to
208 # make sure no handles are shared between threads
210 my %seek_and_destroy;
212 sub _arm_global_destructor {
214 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
219 local $?; # just in case the DBI destructor changes it somehow
221 # destroy just the object if not native to this process
222 $_->_verify_pid for (grep
224 values %seek_and_destroy
229 # As per DBI's recommendation, DBIC disconnects all handles as
230 # soon as possible (DBIC will reconnect only on demand from within
232 my @instances = grep { defined $_ } values %seek_and_destroy;
233 %seek_and_destroy = ();
238 $_->transaction_depth(0);
241 # properly renumber existing refs
242 $_->_arm_global_destructor
250 # some databases spew warnings on implicit disconnect
251 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
252 local $SIG{__WARN__} = sub {};
255 # this op is necessary, since the very last perl runtime statement
256 # triggers a global destruction shootout, and the $SIG localization
257 # may very well be destroyed before perl actually gets to do the
262 # handle pid changes correctly - do not destroy parent's connection
266 my $pid = $self->_conn_pid;
267 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
268 $dbh->{InactiveDestroy} = 1;
270 $self->transaction_depth(0);
271 $self->savepoints([]);
279 This method is normally called by L<DBIx::Class::Schema/connection>, which
280 encapsulates its argument list in an arrayref before passing them here.
282 The argument list may contain:
288 The same 4-element argument set one would normally pass to
289 L<DBI/connect>, optionally followed by
290 L<extra attributes|/DBIx::Class specific connection attributes>
291 recognized by DBIx::Class:
293 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
297 A single code reference which returns a connected
298 L<DBI database handle|DBI/connect> optionally followed by
299 L<extra attributes|/DBIx::Class specific connection attributes> recognized
302 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
306 A single hashref with all the attributes and the dsn/user/password
309 $connect_info_args = [{
317 $connect_info_args = [{
318 dbh_maker => sub { DBI->connect (...) },
323 This is particularly useful for L<Catalyst> based applications, allowing the
324 following config (L<Config::General> style):
329 dsn dbi:mysql:database=test
336 The C<dsn>/C<user>/C<password> combination can be substituted by the
337 C<dbh_maker> key whose value is a coderef that returns a connected
338 L<DBI database handle|DBI/connect>
342 Please note that the L<DBI> docs recommend that you always explicitly
343 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
344 recommends that it be set to I<1>, and that you perform transactions
345 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
346 to I<1> if you do not do explicitly set it to zero. This is the default
347 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
349 =head3 DBIx::Class specific connection attributes
351 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
352 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
353 the following connection options. These options can be mixed in with your other
354 L<DBI> connection attributes, or placed in a separate hashref
355 (C<\%extra_attributes>) as shown above.
357 Every time C<connect_info> is invoked, any previous settings for
358 these options will be cleared before setting the new ones, regardless of
359 whether any options are specified in the new C<connect_info>.
366 Specifies things to do immediately after connecting or re-connecting to
367 the database. Its value may contain:
373 This contains one SQL statement to execute.
375 =item an array reference
377 This contains SQL statements to execute in order. Each element contains
378 a string or a code reference that returns a string.
380 =item a code reference
382 This contains some code to execute. Unlike code references within an
383 array reference, its return value is ignored.
387 =item on_disconnect_do
389 Takes arguments in the same form as L</on_connect_do> and executes them
390 immediately before disconnecting from the database.
392 Note, this only runs if you explicitly call L</disconnect> on the
395 =item on_connect_call
397 A more generalized form of L</on_connect_do> that calls the specified
398 C<connect_call_METHOD> methods in your storage driver.
400 on_connect_do => 'select 1'
404 on_connect_call => [ [ do_sql => 'select 1' ] ]
406 Its values may contain:
412 Will call the C<connect_call_METHOD> method.
414 =item a code reference
416 Will execute C<< $code->($storage) >>
418 =item an array reference
420 Each value can be a method name or code reference.
422 =item an array of arrays
424 For each array, the first item is taken to be the C<connect_call_> method name
425 or code reference, and the rest are parameters to it.
429 Some predefined storage methods you may use:
435 Executes a SQL string or a code reference that returns a SQL string. This is
436 what L</on_connect_do> and L</on_disconnect_do> use.
444 Will execute the scalar as SQL.
448 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
449 attributes hashref and bind values.
451 =item a code reference
453 Will execute C<< $code->($storage) >> and execute the return array refs as
460 Execute any statements necessary to initialize the database session to return
461 and accept datetime/timestamp values used with
462 L<DBIx::Class::InflateColumn::DateTime>.
464 Only necessary for some databases, see your specific storage driver for
465 implementation details.
469 =item on_disconnect_call
471 Takes arguments in the same form as L</on_connect_call> and executes them
472 immediately before disconnecting from the database.
474 Calls the C<disconnect_call_METHOD> methods as opposed to the
475 C<connect_call_METHOD> methods called by L</on_connect_call>.
477 Note, this only runs if you explicitly call L</disconnect> on the
480 =item disable_sth_caching
482 If set to a true value, this option will disable the caching of
483 statement handles via L<DBI/prepare_cached>.
487 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
488 default L</sql_limit_dialect> setting of the storage (if any). For a list
489 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
493 When true automatically sets L</quote_char> and L</name_sep> to the characters
494 appropriate for your particular RDBMS. This option is preferred over specifying
495 L</quote_char> directly.
499 Specifies what characters to use to quote table and column names.
501 C<quote_char> expects either a single character, in which case is it
502 is placed on either side of the table/column name, or an arrayref of length
503 2 in which case the table/column name is placed between the elements.
505 For example under MySQL you should use C<< quote_char => '`' >>, and for
506 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
510 This parameter is only useful in conjunction with C<quote_char>, and is used to
511 specify the character that separates elements (schemas, tables, columns) from
512 each other. If unspecified it defaults to the most commonly used C<.>.
516 This Storage driver normally installs its own C<HandleError>, sets
517 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
518 all database handles, including those supplied by a coderef. It does this
519 so that it can have consistent and useful error behavior.
521 If you set this option to a true value, Storage will not do its usual
522 modifications to the database handle's attributes, and instead relies on
523 the settings in your connect_info DBI options (or the values you set in
524 your connection coderef, in the case that you are connecting via coderef).
526 Note that your custom settings can cause Storage to malfunction,
527 especially if you set a C<HandleError> handler that suppresses exceptions
528 and/or disable C<RaiseError>.
532 If this option is true, L<DBIx::Class> will use savepoints when nesting
533 transactions, making it possible to recover from failure in the inner
534 transaction without having to abort all outer transactions.
538 Use this argument to supply a cursor class other than the default
539 L<DBIx::Class::Storage::DBI::Cursor>.
543 Some real-life examples of arguments to L</connect_info> and
544 L<DBIx::Class::Schema/connect>
546 # Simple SQLite connection
547 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
550 ->connect_info([ sub { DBI->connect(...) } ]);
552 # Connect via subref in hashref
554 dbh_maker => sub { DBI->connect(...) },
555 on_connect_do => 'alter session ...',
558 # A bit more complicated
565 { quote_char => q{"} },
569 # Equivalent to the previous example
575 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
579 # Same, but with hashref as argument
580 # See parse_connect_info for explanation
583 dsn => 'dbi:Pg:dbname=foo',
585 password => 'my_pg_password',
592 # Subref + DBIx::Class-specific connection options
595 sub { DBI->connect(...) },
599 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
600 disable_sth_caching => 1,
610 my ($self, $info) = @_;
612 return $self->_connect_info if !$info;
614 $self->_connect_info($info); # copy for _connect_info
616 $info = $self->_normalize_connect_info($info)
617 if ref $info eq 'ARRAY';
619 for my $storage_opt (keys %{ $info->{storage_options} }) {
620 my $value = $info->{storage_options}{$storage_opt};
622 $self->$storage_opt($value);
625 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
626 # the new set of options
627 $self->_sql_maker(undef);
628 $self->_sql_maker_opts({});
630 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
631 my $value = $info->{sql_maker_options}{$sql_maker_opt};
633 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
637 %{ $self->_default_dbi_connect_attributes || {} },
638 %{ $info->{attributes} || {} },
641 my @args = @{ $info->{arguments} };
643 if (keys %attrs and ref $args[0] ne 'CODE') {
645 'You provided explicit AutoCommit => 0 in your connection_info. '
646 . 'This is almost universally a bad idea (see the footnotes of '
647 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
648 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
650 ) if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
652 push @args, \%attrs if keys %attrs;
654 $self->_dbi_connect_info(\@args);
657 # save attributes them in a separate accessor so they are always
658 # introspectable, even in case of a CODE $dbhmaker
659 $self->_dbic_connect_attributes (\%attrs);
661 return $self->_connect_info;
664 sub _normalize_connect_info {
665 my ($self, $info_arg) = @_;
668 my @args = @$info_arg; # take a shallow copy for further mutilation
670 # combine/pre-parse arguments depending on invocation style
673 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
674 %attrs = %{ $args[1] || {} };
677 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
678 %attrs = %{$args[0]};
680 if (my $code = delete $attrs{dbh_maker}) {
683 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
686 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
687 . "to the result of 'dbh_maker'",
689 join (', ', map { "'$_'" } (@ignored) ),
694 @args = delete @attrs{qw/dsn user password/};
697 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
699 % { $args[3] || {} },
700 % { $args[4] || {} },
702 @args = @args[0,1,2];
705 $info{arguments} = \@args;
707 my @storage_opts = grep exists $attrs{$_},
708 @storage_options, 'cursor_class';
710 @{ $info{storage_options} }{@storage_opts} =
711 delete @attrs{@storage_opts} if @storage_opts;
713 my @sql_maker_opts = grep exists $attrs{$_},
714 qw/limit_dialect quote_char name_sep quote_names/;
716 @{ $info{sql_maker_options} }{@sql_maker_opts} =
717 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
719 $info{attributes} = \%attrs if %attrs;
724 sub _default_dbi_connect_attributes () {
729 ShowErrorStatement => 1,
735 This method is deprecated in favour of setting via L</connect_info>.
739 =head2 on_disconnect_do
741 This method is deprecated in favour of setting via L</connect_info>.
745 sub _parse_connect_do {
746 my ($self, $type) = @_;
748 my $val = $self->$type;
749 return () if not defined $val;
754 push @res, [ 'do_sql', $val ];
755 } elsif (ref($val) eq 'CODE') {
757 } elsif (ref($val) eq 'ARRAY') {
758 push @res, map { [ 'do_sql', $_ ] } @$val;
760 $self->throw_exception("Invalid type for $type: ".ref($val));
768 Arguments: ($subref | $method_name), @extra_coderef_args?
770 Execute the given $subref or $method_name using the new exception-based
771 connection management.
773 The first two arguments will be the storage object that C<dbh_do> was called
774 on and a database handle to use. Any additional arguments will be passed
775 verbatim to the called subref as arguments 2 and onwards.
777 Using this (instead of $self->_dbh or $self->dbh) ensures correct
778 exception handling and reconnection (or failover in future subclasses).
780 Your subref should have no side-effects outside of the database, as
781 there is the potential for your subref to be partially double-executed
782 if the database connection was stale/dysfunctional.
786 my @stuff = $schema->storage->dbh_do(
788 my ($storage, $dbh, @cols) = @_;
789 my $cols = join(q{, }, @cols);
790 $dbh->selectrow_array("SELECT $cols FROM foo");
799 my $run_target = shift;
801 # short circuit when we know there is no need for a runner
803 # FIXME - assumption may be wrong
804 # the rationale for the txn_depth check is that if this block is a part
805 # of a larger transaction, everything up to that point is screwed anyway
806 return $self->$run_target($self->_get_dbh, @_)
807 if $self->{_in_do_block} or $self->transaction_depth;
809 # take a ref instead of a copy, to preserve @_ aliasing
810 # semantics within the coderef, but only if needed
811 # (pseudoforking doesn't like this trick much)
812 my $args = @_ ? \@_ : [];
814 DBIx::Class::Storage::BlockRunner->new(
816 run_code => sub { $self->$run_target ($self->_get_dbh, @$args ) },
818 retry_handler => sub { ! ( $_[0]->retried_count or $_[0]->storage->connected ) },
823 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
824 shift->next::method(@_);
829 Our C<disconnect> method also performs a rollback first if the
830 database is not in C<AutoCommit> mode.
840 push @actions, ( $self->on_disconnect_call || () );
841 push @actions, $self->_parse_connect_do ('on_disconnect_do');
843 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
845 # stops the "implicit rollback on disconnect" warning
846 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
848 %{ $self->_dbh->{CachedKids} } = ();
849 $self->_dbh->disconnect;
854 =head2 with_deferred_fk_checks
858 =item Arguments: C<$coderef>
860 =item Return Value: The return value of $coderef
864 Storage specific method to run the code ref with FK checks deferred or
865 in MySQL's case disabled entirely.
869 # Storage subclasses should override this
870 sub with_deferred_fk_checks {
871 my ($self, $sub) = @_;
879 =item Arguments: none
881 =item Return Value: 1|0
885 Verifies that the current database handle is active and ready to execute
886 an SQL statement (e.g. the connection did not get stale, server is still
887 answering, etc.) This method is used internally by L</dbh>.
893 return 0 unless $self->_seems_connected;
896 local $self->_dbh->{RaiseError} = 1;
901 sub _seems_connected {
904 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
906 my $dbh = $self->_dbh
909 return $dbh->FETCH('Active');
915 my $dbh = $self->_dbh or return 0;
920 sub ensure_connected {
923 unless ($self->connected) {
924 $self->_populate_dbh;
930 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
931 is guaranteed to be healthy by implicitly calling L</connected>, and if
932 necessary performing a reconnection before returning. Keep in mind that this
933 is very B<expensive> on some database engines. Consider using L</dbh_do>
941 if (not $self->_dbh) {
942 $self->_populate_dbh;
944 $self->ensure_connected;
949 # this is the internal "get dbh or connect (don't check)" method
952 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
953 $self->_populate_dbh unless $self->_dbh;
959 unless ($self->_sql_maker) {
960 my $sql_maker_class = $self->sql_maker_class;
962 my %opts = %{$self->_sql_maker_opts||{}};
966 $self->sql_limit_dialect
969 my $s_class = (ref $self) || $self;
971 "Your storage class ($s_class) does not set sql_limit_dialect and you "
972 . 'have not supplied an explicit limit_dialect in your connection_info. '
973 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
974 . 'databases but can be (and often is) painfully slow. '
975 . "Please file an RT ticket against '$s_class'"
976 ) if $self->_dbi_connect_info->[0];
982 my ($quote_char, $name_sep);
984 if ($opts{quote_names}) {
985 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
986 my $s_class = (ref $self) || $self;
988 "You requested 'quote_names' but your storage class ($s_class) does "
989 . 'not explicitly define a default sql_quote_char and you have not '
990 . 'supplied a quote_char as part of your connection_info. DBIC will '
991 .q{default to the ANSI SQL standard quote '"', which works most of }
992 . "the time. Please file an RT ticket against '$s_class'."
998 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
1001 $self->_sql_maker($sql_maker_class->new(
1002 bindtype=>'columns',
1003 array_datatypes => 1,
1004 limit_dialect => $dialect,
1005 ($quote_char ? (quote_char => $quote_char) : ()),
1006 name_sep => ($name_sep || '.'),
1010 return $self->_sql_maker;
1013 # nothing to do by default
1020 my @info = @{$self->_dbi_connect_info || []};
1021 $self->_dbh(undef); # in case ->connected failed we might get sent here
1022 $self->_dbh_details({}); # reset everything we know
1024 $self->_dbh($self->_connect(@info));
1026 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1028 $self->_determine_driver;
1030 # Always set the transaction depth on connect, since
1031 # there is no transaction in progress by definition
1032 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1034 $self->_run_connection_actions unless $self->{_in_determine_driver};
1037 sub _run_connection_actions {
1041 push @actions, ( $self->on_connect_call || () );
1042 push @actions, $self->_parse_connect_do ('on_connect_do');
1044 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1049 sub set_use_dbms_capability {
1050 $_[0]->set_inherited ($_[1], $_[2]);
1053 sub get_use_dbms_capability {
1054 my ($self, $capname) = @_;
1056 my $use = $self->get_inherited ($capname);
1059 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1063 sub set_dbms_capability {
1064 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1067 sub get_dbms_capability {
1068 my ($self, $capname) = @_;
1070 my $cap = $self->_dbh_details->{capability}{$capname};
1072 unless (defined $cap) {
1073 if (my $meth = $self->can ("_determine$capname")) {
1074 $cap = $self->$meth ? 1 : 0;
1080 $self->set_dbms_capability ($capname, $cap);
1090 unless ($info = $self->_dbh_details->{info}) {
1094 my $server_version = try {
1095 $self->_get_server_version
1097 # driver determination *may* use this codepath
1098 # in which case we must rethrow
1099 $self->throw_exception($_) if $self->{_in_determine_driver};
1101 # $server_version on failure
1105 if (defined $server_version) {
1106 $info->{dbms_version} = $server_version;
1108 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1109 my @verparts = split (/\./, $numeric_version);
1115 # consider only up to 3 version parts, iff not more than 3 digits
1117 while (@verparts && @use_parts < 3) {
1118 my $p = shift @verparts;
1120 push @use_parts, $p;
1122 push @use_parts, 0 while @use_parts < 3;
1124 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1128 $self->_dbh_details->{info} = $info;
1134 sub _get_server_version {
1135 shift->_dbh_get_info('SQL_DBMS_VER');
1139 my ($self, $info) = @_;
1141 if ($info =~ /[^0-9]/) {
1142 require DBI::Const::GetInfoType;
1143 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1144 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1145 unless defined $info;
1148 $self->_get_dbh->get_info($info);
1151 sub _describe_connection {
1152 require DBI::Const::GetInfoReturn;
1155 $self->ensure_connected;
1158 DBIC_DSN => $self->_dbi_connect_info->[0],
1159 DBI_VER => DBI->VERSION,
1160 DBIC_VER => DBIx::Class->VERSION,
1161 DBIC_DRIVER => ref $self,
1165 #keys %DBI::Const::GetInfoType::GetInfoType,
1167 SQL_CURSOR_COMMIT_BEHAVIOR
1168 SQL_CURSOR_ROLLBACK_BEHAVIOR
1169 SQL_CURSOR_SENSITIVITY
1170 SQL_DATA_SOURCE_NAME
1173 SQL_DEFAULT_TXN_ISOLATION
1178 SQL_EXPRESSIONS_IN_ORDERBY
1181 SQL_IDENTIFIER_QUOTE_CHAR
1182 SQL_MAX_CATALOG_NAME_LEN
1183 SQL_MAX_COLUMN_NAME_LEN
1184 SQL_MAX_IDENTIFIER_LEN
1185 SQL_MAX_TABLE_NAME_LEN
1186 SQL_MULTIPLE_ACTIVE_TXN
1187 SQL_MULT_RESULT_SETS
1188 SQL_NEED_LONG_DATA_LEN
1189 SQL_NON_NULLABLE_COLUMNS
1191 SQL_QUALIFIER_NAME_SEPARATOR
1192 SQL_QUOTED_IDENTIFIER_CASE
1194 SQL_TXN_ISOLATION_OPTION
1197 # some drivers barf on things they do not know about instead
1198 # of returning undef
1199 my $v = try { $self->_dbh_get_info($inf) };
1200 next unless defined $v;
1202 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1203 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1204 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1210 sub _determine_driver {
1213 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1214 my $started_connected = 0;
1215 local $self->{_in_determine_driver} = 1;
1217 if (ref($self) eq __PACKAGE__) {
1219 if ($self->_dbh) { # we are connected
1220 $driver = $self->_dbh->{Driver}{Name};
1221 $started_connected = 1;
1224 # if connect_info is a CODEREF, we have no choice but to connect
1225 if (ref $self->_dbi_connect_info->[0] &&
1226 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1227 $self->_populate_dbh;
1228 $driver = $self->_dbh->{Driver}{Name};
1231 # try to use dsn to not require being connected, the driver may still
1232 # force a connection in _rebless to determine version
1233 # (dsn may not be supplied at all if all we do is make a mock-schema)
1234 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1235 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1236 $driver ||= $ENV{DBI_DRIVER};
1241 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1242 if ($self->load_optional_class($storage_class)) {
1243 mro::set_mro($storage_class, 'c3');
1244 bless $self, $storage_class;
1248 $self->_warn_undetermined_driver(
1249 'This version of DBIC does not yet seem to supply a driver for '
1250 . "your particular RDBMS and/or connection method ('$driver')."
1255 $self->_warn_undetermined_driver(
1256 'Unable to extract a driver name from connect info - this '
1257 . 'should not have happened.'
1262 $self->_driver_determined(1);
1264 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1266 if ($self->can('source_bind_attributes')) {
1267 $self->throw_exception(
1268 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1269 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1270 . 'If you are not sure how to proceed please contact the development team via '
1271 . 'http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT'
1275 $self->_init; # run driver-specific initializations
1277 $self->_run_connection_actions
1278 if !$started_connected && defined $self->_dbh;
1282 sub _determine_connector_driver {
1283 my ($self, $conn) = @_;
1285 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1288 $self->_warn_undetermined_driver(
1289 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1290 . "$conn connector - this should not have happened."
1295 $dbtype =~ s/\W/_/gi;
1297 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1298 return if $self->isa($subclass);
1300 if ($self->load_optional_class($subclass)) {
1301 bless $self, $subclass;
1305 $self->_warn_undetermined_driver(
1306 'This version of DBIC does not yet seem to supply a driver for '
1307 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1312 sub _warn_undetermined_driver {
1313 my ($self, $msg) = @_;
1315 require Data::Dumper::Concise;
1317 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1318 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1319 . "does not go away, file a bugreport including the following info:\n"
1320 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1324 sub _do_connection_actions {
1326 my $method_prefix = shift;
1329 if (not ref($call)) {
1330 my $method = $method_prefix . $call;
1332 } elsif (ref($call) eq 'CODE') {
1334 } elsif (ref($call) eq 'ARRAY') {
1335 if (ref($call->[0]) ne 'ARRAY') {
1336 $self->_do_connection_actions($method_prefix, $_) for @$call;
1338 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1341 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1347 sub connect_call_do_sql {
1349 $self->_do_query(@_);
1352 sub disconnect_call_do_sql {
1354 $self->_do_query(@_);
1357 # override in db-specific backend when necessary
1358 sub connect_call_datetime_setup { 1 }
1361 my ($self, $action) = @_;
1363 if (ref $action eq 'CODE') {
1364 $action = $action->($self);
1365 $self->_do_query($_) foreach @$action;
1368 # Most debuggers expect ($sql, @bind), so we need to exclude
1369 # the attribute hash which is the second argument to $dbh->do
1370 # furthermore the bind values are usually to be presented
1371 # as named arrayref pairs, so wrap those here too
1372 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1373 my $sql = shift @do_args;
1374 my $attrs = shift @do_args;
1375 my @bind = map { [ undef, $_ ] } @do_args;
1378 $_[0]->_query_start($sql, \@bind);
1379 $_[1]->do($sql, $attrs, @do_args);
1380 $_[0]->_query_end($sql, \@bind);
1388 my ($self, @info) = @_;
1390 $self->throw_exception("You did not provide any connection_info")
1391 if ( ! defined $info[0] and ! $ENV{DBI_DSN} and ! $ENV{DBI_DRIVER} );
1393 my ($old_connect_via, $dbh);
1395 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1397 # this odd anonymous coderef dereference is in fact really
1398 # necessary to avoid the unwanted effect described in perl5
1401 # in addition the coderef itself can't reside inside the try{} block below
1402 # as it somehow triggers a leak under perl -d
1403 my $dbh_error_handler_installer = sub {
1404 weaken (my $weak_self = $_[0]);
1406 # the coderef is blessed so we can distinguish it from externally
1407 # supplied handles (which must be preserved)
1408 $_[1]->{HandleError} = bless sub {
1410 $weak_self->throw_exception("DBI Exception: $_[0]");
1413 # the handler may be invoked by something totally out of
1415 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1417 }, '__DBIC__DBH__ERROR__HANDLER__';
1421 if(ref $info[0] eq 'CODE') {
1422 $dbh = $info[0]->();
1426 $dbh = DBI->connect(@info);
1429 die $DBI::errstr unless $dbh;
1431 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1432 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1434 ref $info[0] eq 'CODE'
1435 ? "Connection coderef $info[0] returned a"
1436 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1437 ) unless $dbh->FETCH('Active');
1439 # sanity checks unless asked otherwise
1440 unless ($self->unsafe) {
1442 $self->throw_exception(
1443 'Refusing clobbering of {HandleError} installed on externally supplied '
1444 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1445 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1447 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1448 # request, or an external handle. Complain and set anyway
1449 unless ($dbh->{RaiseError}) {
1450 carp( ref $info[0] eq 'CODE'
1452 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1453 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1454 .'attribute has been supplied'
1456 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1457 .'unsafe => 1. Toggling RaiseError back to true'
1460 $dbh->{RaiseError} = 1;
1463 $dbh_error_handler_installer->($self, $dbh);
1467 $self->throw_exception("DBI Connection failed: $_")
1470 $self->_dbh_autocommit($dbh->{AutoCommit});
1477 # this means we have not yet connected and do not know the AC status
1478 # (e.g. coderef $dbh), need a full-fledged connection check
1479 if (! defined $self->_dbh_autocommit) {
1480 $self->ensure_connected;
1482 # Otherwise simply connect or re-connect on pid changes
1487 $self->next::method(@_);
1490 sub _exec_txn_begin {
1493 # if the user is utilizing txn_do - good for him, otherwise we need to
1494 # ensure that the $dbh is healthy on BEGIN.
1495 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1496 # will be replaced by a failure of begin_work itself (which will be
1497 # then retried on reconnect)
1498 if ($self->{_in_do_block}) {
1499 $self->_dbh->begin_work;
1501 $self->dbh_do(sub { $_[1]->begin_work });
1508 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1509 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1512 # esoteric case for folks using external $dbh handles
1513 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1514 carp "Storage transaction_depth 0 does not match "
1515 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1516 $self->transaction_depth(1);
1519 $self->next::method(@_);
1521 # if AutoCommit is disabled txn_depth never goes to 0
1522 # as a new txn is started immediately on commit
1523 $self->transaction_depth(1) if (
1524 !$self->transaction_depth
1526 defined $self->_dbh_autocommit
1528 ! $self->_dbh_autocommit
1532 sub _exec_txn_commit {
1533 shift->_dbh->commit;
1539 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1540 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1543 # esoteric case for folks using external $dbh handles
1544 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1545 carp "Storage transaction_depth 0 does not match "
1546 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1547 $self->transaction_depth(1);
1550 $self->next::method(@_);
1552 # if AutoCommit is disabled txn_depth never goes to 0
1553 # as a new txn is started immediately on commit
1554 $self->transaction_depth(1) if (
1555 !$self->transaction_depth
1557 defined $self->_dbh_autocommit
1559 ! $self->_dbh_autocommit
1563 sub _exec_txn_rollback {
1564 shift->_dbh->rollback;
1567 # generate some identical methods
1568 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1570 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1572 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1573 $self->throw_exception("Unable to $meth() on a disconnected storage")
1575 $self->next::method(@_);
1579 # This used to be the top-half of _execute. It was split out to make it
1580 # easier to override in NoBindVars without duping the rest. It takes up
1581 # all of _execute's args, and emits $sql, @bind.
1582 sub _prep_for_execute {
1583 #my ($self, $op, $ident, $args) = @_;
1584 return shift->_gen_sql_bind(@_)
1588 my ($self, $op, $ident, $args) = @_;
1590 my ($colinfos, $from);
1591 if ( blessed($ident) ) {
1592 $from = $ident->from;
1593 $colinfos = $ident->columns_info;
1597 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1599 $bind = $self->_resolve_bindattrs(
1600 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1604 ! $ENV{DBIC_DT_SEARCH_OK}
1613 $_->[1]->isa('DateTime')
1616 carp_unique 'DateTime objects passed to search() are not supported '
1617 . 'properly (InflateColumn::DateTime formats and settings are not '
1618 . 'respected.) See "Formatting DateTime objects in queries" in '
1619 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1620 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1623 return( $sql, $bind );
1626 sub _resolve_bindattrs {
1627 my ($self, $ident, $bind, $colinfos) = @_;
1631 my $resolve_bindinfo = sub {
1632 #my $infohash = shift;
1634 %$colinfos = %{ $self->_resolve_column_info($ident) }
1635 unless keys %$colinfos;
1638 if (my $col = $_[0]->{dbic_colname}) {
1639 $ret = { %{$_[0]} };
1641 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1642 if $colinfos->{$col}{data_type};
1644 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1645 if $colinfos->{$col}{size};
1653 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1654 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1655 : (ref $_->[0] eq 'HASH') ? [ (exists $_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype})
1657 : $resolve_bindinfo->($_->[0])
1659 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1660 : [ $resolve_bindinfo->(
1661 { dbic_colname => $_->[0] }
1666 ! exists $resolved->[0]{dbd_attrs}
1668 ! $resolved->[0]{sqlt_datatype}
1670 length ref $resolved->[1]
1672 ! overload::Method($resolved->[1], '""')
1674 require Data::Dumper;
1675 local $Data::Dumper::Maxdepth = 1;
1676 local $Data::Dumper::Terse = 1;
1677 local $Data::Dumper::Useqq = 1;
1678 local $Data::Dumper::Indent = 0;
1679 local $Data::Dumper::Pad = ' ';
1680 $self->throw_exception(
1681 'You must supply a datatype/bindtype (see DBIx::Class::ResultSet/DBIC BIND VALUES) '
1682 . 'for non-scalar value '. Data::Dumper::Dumper ($resolved->[1])
1691 sub _format_for_trace {
1692 #my ($self, $bind) = @_;
1694 ### Turn @bind from something like this:
1695 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1697 ### ( "'1'", "'3'" )
1700 defined( $_ && $_->[1] )
1707 my ( $self, $sql, $bind ) = @_;
1709 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1714 my ( $self, $sql, $bind ) = @_;
1716 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1720 sub _dbi_attrs_for_bind {
1721 my ($self, $ident, $bind) = @_;
1725 for (map { $_->[0] } @$bind) {
1727 if (exists $_->{dbd_attrs}) {
1730 elsif($_->{sqlt_datatype}) {
1731 # cache the result in the dbh_details hash, as it can not change unless
1732 # we connect to something else
1733 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1734 if (not exists $cache->{$_->{sqlt_datatype}}) {
1735 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1737 $cache->{$_->{sqlt_datatype}};
1740 undef; # always push something at this position
1749 my ($self, $op, $ident, @args) = @_;
1751 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1753 # not even a PID check - we do not care about the state of the _dbh.
1754 # All we need is to get the appropriate drivers loaded if they aren't
1755 # already so that the assumption in ad7c50fc26e holds
1756 $self->_populate_dbh unless $self->_dbh;
1758 $self->dbh_do( _dbh_execute => # retry over disconnects
1761 $self->_dbi_attrs_for_bind($ident, $bind),
1766 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1768 $self->_query_start( $sql, $bind );
1770 my $sth = $self->_bind_sth_params(
1771 $self->_prepare_sth($dbh, $sql),
1776 # Can this fail without throwing an exception anyways???
1777 my $rv = $sth->execute();
1778 $self->throw_exception(
1779 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1782 $self->_query_end( $sql, $bind );
1784 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1788 my ($self, $dbh, $sql) = @_;
1790 # 3 is the if_active parameter which avoids active sth re-use
1791 my $sth = $self->disable_sth_caching
1792 ? $dbh->prepare($sql)
1793 : $dbh->prepare_cached($sql, {}, 3);
1795 # XXX You would think RaiseError would make this impossible,
1796 # but apparently that's not true :(
1797 $self->throw_exception(
1800 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1801 .'an exception and/or setting $dbh->errstr',
1803 ? substr($sql, 0, 20) . '...'
1806 'DBD::' . $dbh->{Driver}{Name},
1813 sub _bind_sth_params {
1814 my ($self, $sth, $bind, $bind_attrs) = @_;
1816 for my $i (0 .. $#$bind) {
1817 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1818 $sth->bind_param_inout(
1819 $i + 1, # bind params counts are 1-based
1821 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1826 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1827 # confirm with dbi-dev whether explicit stringification is needed
1828 my $v = ( length ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""') )
1843 sub _prefetch_autovalues {
1844 my ($self, $source, $colinfo, $to_insert) = @_;
1847 for my $col (keys %$colinfo) {
1849 $colinfo->{$col}{auto_nextval}
1852 ! exists $to_insert->{$col}
1854 ref $to_insert->{$col} eq 'SCALAR'
1856 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1859 $values{$col} = $self->_sequence_fetch(
1861 ( $colinfo->{$col}{sequence} ||=
1862 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1872 my ($self, $source, $to_insert) = @_;
1874 my $col_infos = $source->columns_info;
1876 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1878 # fuse the values, but keep a separate list of prefetched_values so that
1879 # they can be fused once again with the final return
1880 $to_insert = { %$to_insert, %$prefetched_values };
1882 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1883 # Investigate what does it take to s/defined/exists/
1884 my %pcols = map { $_ => 1 } $source->primary_columns;
1885 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1886 for my $col ($source->columns) {
1887 if ($col_infos->{$col}{is_auto_increment}) {
1888 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1889 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1892 # nothing to retrieve when explicit values are supplied
1893 next if (defined $to_insert->{$col} and ! (
1894 ref $to_insert->{$col} eq 'SCALAR'
1896 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1899 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1900 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1903 $col_infos->{$col}{retrieve_on_insert}
1907 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1908 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1910 my ($sqla_opts, @ir_container);
1911 if (%retrieve_cols and $self->_use_insert_returning) {
1912 $sqla_opts->{returning_container} = \@ir_container
1913 if $self->_use_insert_returning_bound;
1915 $sqla_opts->{returning} = [
1916 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1920 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1922 my %returned_cols = %$to_insert;
1923 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1924 @ir_container = try {
1925 local $SIG{__WARN__} = sub {};
1926 my @r = $sth->fetchrow_array;
1929 } unless @ir_container;
1931 @returned_cols{@$retlist} = @ir_container if @ir_container;
1934 # pull in PK if needed and then everything else
1935 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1937 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1938 unless $self->can('last_insert_id');
1940 my @pri_values = $self->last_insert_id($source, @missing_pri);
1942 $self->throw_exception( "Can't get last insert id" )
1943 unless (@pri_values == @missing_pri);
1945 @returned_cols{@missing_pri} = @pri_values;
1946 delete @retrieve_cols{@missing_pri};
1949 # if there is more left to pull
1950 if (%retrieve_cols) {
1951 $self->throw_exception(
1952 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1955 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1957 my $cur = DBIx::Class::ResultSet->new($source, {
1958 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
1959 select => \@left_to_fetch,
1962 @returned_cols{@left_to_fetch} = $cur->next;
1964 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
1965 if scalar $cur->next;
1969 return { %$prefetched_values, %returned_cols };
1973 my ($self, $source, $cols, $data) = @_;
1975 my @col_range = (0..$#$cols);
1977 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1978 # confirm with dbi-dev whether explicit stringification is needed
1980 # forcibly stringify whatever is stringifiable
1981 # ResultSet::populate() hands us a copy - safe to mangle
1982 for my $r (0 .. $#$data) {
1983 for my $c (0 .. $#{$data->[$r]}) {
1984 $data->[$r][$c] = "$data->[$r][$c]"
1985 if ( length ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
1989 my $colinfos = $source->columns_info($cols);
1991 local $self->{_autoinc_supplied_for_op} =
1992 (first { $_->{is_auto_increment} } values %$colinfos)
1997 # get a slice type index based on first row of data
1998 # a "column" in this context may refer to more than one bind value
1999 # e.g. \[ '?, ?', [...], [...] ]
2001 # construct the value type index - a description of values types for every
2002 # per-column slice of $data:
2004 # nonexistent - nonbind literal
2006 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
2008 # also construct the column hash to pass to the SQL generator. For plain
2009 # (non literal) values - convert the members of the first row into a
2010 # literal+bind combo, with extra positional info in the bind attr hashref.
2011 # This will allow us to match the order properly, and is so contrived
2012 # because a user-supplied literal/bind (or something else specific to a
2013 # resultsource and/or storage driver) can inject extra binds along the
2014 # way, so one can't rely on "shift positions" ordering at all. Also we
2015 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
2016 # can be later matched up by address), because we want to supply a real
2017 # value on which perhaps e.g. datatype checks will be performed
2018 my ($proto_data, $value_type_by_col_idx);
2019 for my $i (@col_range) {
2020 my $colname = $cols->[$i];
2021 if (ref $data->[0][$i] eq 'SCALAR') {
2022 # no bind value at all - no type
2024 $proto_data->{$colname} = $data->[0][$i];
2026 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
2027 # repack, so we don't end up mangling the original \[]
2028 my ($sql, @bind) = @${$data->[0][$i]};
2030 # normalization of user supplied stuff
2031 my $resolved_bind = $self->_resolve_bindattrs(
2032 $source, \@bind, $colinfos,
2035 # store value-less (attrs only) bind info - we will be comparing all
2036 # supplied binds against this for sanity
2037 $value_type_by_col_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
2039 $proto_data->{$colname} = \[ $sql, map { [
2040 # inject slice order to use for $proto_bind construction
2041 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i, _literal_bind_subindex => $_+1 }
2043 $resolved_bind->[$_][1]
2048 $value_type_by_col_idx->{$i} = undef;
2050 $proto_data->{$colname} = \[ '?', [
2051 { dbic_colname => $colname, _bind_data_slice_idx => $i }
2058 my ($sql, $proto_bind) = $self->_prep_for_execute (
2064 if (! @$proto_bind and keys %$value_type_by_col_idx) {
2065 # if the bindlist is empty and we had some dynamic binds, this means the
2066 # storage ate them away (e.g. the NoBindVars component) and interpolated
2067 # them directly into the SQL. This obviously can't be good for multi-inserts
2068 $self->throw_exception('Cannot insert_bulk without support for placeholders');
2072 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2074 # use an error reporting closure for convenience (less to pass)
2075 my $bad_slice_report_cref = sub {
2076 my ($msg, $r_idx, $c_idx) = @_;
2077 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2081 require Data::Dumper::Concise;
2082 local $Data::Dumper::Maxdepth = 5;
2083 Data::Dumper::Concise::Dumper ({
2084 map { $cols->[$_] =>
2092 for my $col_idx (@col_range) {
2093 my $reference_val = $data->[0][$col_idx];
2095 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2096 my $val = $data->[$row_idx][$col_idx];
2098 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2099 if (ref $val ne 'SCALAR') {
2100 $bad_slice_report_cref->(
2101 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2106 elsif ($$val ne $$reference_val) {
2107 $bad_slice_report_cref->(
2108 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2114 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2115 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
2116 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2119 else { # binds from a \[], compare type and attrs
2120 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2121 $bad_slice_report_cref->(
2122 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2127 # start drilling down and bail out early on identical refs
2129 $reference_val != $val
2131 $$reference_val != $$val
2133 if (${$val}->[0] ne ${$reference_val}->[0]) {
2134 $bad_slice_report_cref->(
2135 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2140 # need to check the bind attrs - a bind will happen only once for
2141 # the entire dataset, so any changes further down will be ignored.
2142 elsif (! Data::Compare::Compare(
2143 $value_type_by_col_idx->{$col_idx},
2147 @{$self->_resolve_bindattrs(
2148 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2152 $bad_slice_report_cref->(
2153 'Differing bind attributes on literal/bind values not supported',
2163 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2164 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2166 my $guard = $self->txn_scope_guard;
2168 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2169 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2172 # proto bind contains the information on which pieces of $data to pull
2173 # $cols is passed in only for prettier error-reporting
2174 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2177 # bind_param_array doesn't work if there are no binds
2178 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2182 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2186 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2189 # execute_for_fetch is capable of returning data just fine (it means it
2190 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2191 # is the void-populate fast-path we will just ignore this altogether
2192 # for the time being.
2193 sub _dbh_execute_for_fetch {
2194 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2196 my @idx_range = ( 0 .. $#$proto_bind );
2198 # If we have any bind attributes to take care of, we will bind the
2199 # proto-bind data (which will never be used by execute_for_fetch)
2200 # However since column bindtypes are "sticky", this is sufficient
2201 # to get the DBD to apply the bindtype to all values later on
2203 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2205 for my $i (@idx_range) {
2207 $i+1, # DBI bind indexes are 1-based
2208 $proto_bind->[$i][1],
2210 ) if defined $bind_attrs->[$i];
2213 # At this point $data slots named in the _bind_data_slice_idx of
2214 # each piece of $proto_bind are either \[]s or plain values to be
2215 # passed in. Construct the dispensing coderef. *NOTE* the order
2216 # of $data will differ from this of the ?s in the SQL (due to
2217 # alphabetical ordering by colname). We actually do want to
2218 # preserve this behavior so that prepare_cached has a better
2219 # chance of matching on unrelated calls
2221 my $fetch_row_idx = -1; # saner loop this way
2222 my $fetch_tuple = sub {
2223 return undef if ++$fetch_row_idx > $#$data;
2225 return [ map { defined $_->{_literal_bind_subindex}
2226 ? ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}
2227 ->[ $_->{_literal_bind_subindex} ]
2229 : $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2230 } map { $_->[0] } @$proto_bind];
2233 my $tuple_status = [];
2236 $rv = $sth->execute_for_fetch(
2245 # Not all DBDs are create equal. Some throw on error, some return
2246 # an undef $rv, and some set $sth->err - try whatever we can
2247 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2250 ( !defined $rv or $sth->err )
2253 # Statement must finish even if there was an exception.
2258 $err = shift unless defined $err
2263 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2265 $self->throw_exception("Unexpected populate error: $err")
2266 if ($i > $#$tuple_status);
2268 require Data::Dumper::Concise;
2269 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2270 ($tuple_status->[$i][1] || $err),
2271 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2278 sub _dbh_execute_inserts_with_no_binds {
2279 my ($self, $sth, $count) = @_;
2283 my $dbh = $self->_get_dbh;
2284 local $dbh->{RaiseError} = 1;
2285 local $dbh->{PrintError} = 0;
2287 $sth->execute foreach 1..$count;
2293 # Make sure statement is finished even if there was an exception.
2298 $err = shift unless defined $err;
2301 $self->throw_exception($err) if defined $err;
2307 #my ($self, $source, @args) = @_;
2308 shift->_execute('update', @_);
2313 #my ($self, $source, @args) = @_;
2314 shift->_execute('delete', @_);
2319 $self->_execute($self->_select_args(@_));
2322 sub _select_args_to_query {
2325 $self->throw_exception(
2326 "Unable to generate limited query representation with 'software_limit' enabled"
2327 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2329 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2330 # = $self->_select_args($ident, $select, $cond, $attrs);
2331 my ($op, $ident, @args) =
2332 $self->_select_args(@_);
2334 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2335 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2337 # reuse the bind arrayref
2338 unshift @{$bind}, "($sql)";
2343 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2345 # FIXME - that kind of caching would be nice to have
2346 # however currently we *may* pass the same $orig_attrs
2347 # with different ident/select/where
2348 # the whole interface needs to be rethought, since it
2349 # was centered around the flawed SQLA API. We can do
2350 # soooooo much better now. But that is also another
2353 # 'select', @{$orig_attrs->{_sqlmaker_select_args}}
2354 #) if $orig_attrs->{_sqlmaker_select_args};
2356 my $sql_maker = $self->sql_maker;
2357 my $alias2source = $self->_resolve_ident_sources ($ident);
2365 # limit dialects use this stuff
2366 # yes, some CDBICompat crap does not supply an {alias} >.<
2367 ( $orig_attrs->{alias} and $alias2source->{$orig_attrs->{alias}} )
2368 ? ( _rsroot_rsrc => $alias2source->{$orig_attrs->{alias}} )
2373 # Sanity check the attributes (SQLMaker does it too, but
2374 # in case of a software_limit we'll never reach there)
2375 if (defined $attrs->{offset}) {
2376 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2377 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2380 if (defined $attrs->{rows}) {
2381 $self->throw_exception("The rows attribute must be a positive integer if present")
2382 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2384 elsif ($attrs->{offset}) {
2385 # MySQL actually recommends this approach. I cringe.
2386 $attrs->{rows} = $sql_maker->__max_int;
2389 # see if we will need to tear the prefetch apart to satisfy group_by == select
2390 # this is *extremely tricky* to get right, I am still not sure I did
2392 my ($prefetch_needs_subquery, @limit_args);
2394 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2395 # we already know there is a valid group_by (we made it) and we know it is
2396 # intended to be based *only* on non-multi stuff
2397 # short circuit the group_by parsing below
2398 $prefetch_needs_subquery = 1;
2401 # The rationale is that even if we do *not* have collapse, we still
2402 # need to wrap the core grouped select/group_by in a subquery
2403 # so that databases that care about group_by/select equivalence
2404 # are happy (this includes MySQL in strict_mode)
2405 # If any of the other joined tables are referenced in the group_by
2406 # however - the user is on their own
2407 ( $prefetch_needs_subquery or $attrs->{_related_results_construction} )
2411 @{$attrs->{group_by}}
2413 my $grp_aliases = try { # try{} because $attrs->{from} may be unreadable
2414 $self->_resolve_aliastypes_from_select_args({ from => $attrs->{from}, group_by => $attrs->{group_by} })
2417 # no aliases other than our own in group_by
2418 # if there are - do not allow subquery even if limit is present
2419 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2421 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2422 # active collapse with a limit - that one is a no-brainer unless
2423 # overruled by a group_by above
2424 $prefetch_needs_subquery = 1;
2427 if ($prefetch_needs_subquery) {
2428 $attrs = $self->_adjust_select_args_for_complex_prefetch ($attrs);
2430 elsif (! $attrs->{software_limit} ) {
2432 $attrs->{rows} || (),
2433 $attrs->{offset} || (),
2437 # try to simplify the joinmap further (prune unreferenced type-single joins)
2439 ! $prefetch_needs_subquery # already pruned
2443 reftype $attrs->{from} eq 'ARRAY'
2445 @{$attrs->{from}} != 1
2447 ($attrs->{from}, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($attrs);
2451 # This would be the point to deflate anything found in $attrs->{where}
2452 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2453 # expect a result object. And all we have is a resultsource (it is trivial
2454 # to extract deflator coderefs via $alias2source above).
2456 # I don't see a way forward other than changing the way deflators are
2457 # invoked, and that's just bad...
2460 return ( 'select', @{ $orig_attrs->{_sqlmaker_select_args} = [
2461 @{$attrs}{qw(from select where)}, $attrs, @limit_args
2465 # Returns a counting SELECT for a simple count
2466 # query. Abstracted so that a storage could override
2467 # this to { count => 'firstcol' } or whatever makes
2468 # sense as a performance optimization
2470 #my ($self, $source, $rs_attrs) = @_;
2471 return { count => '*' };
2478 =item Arguments: $ident, $select, $condition, $attrs
2482 Handle a SQL select statement.
2488 my ($ident, $select, $condition, $attrs) = @_;
2489 return $self->cursor_class->new($self, \@_, $attrs);
2494 my ($rv, $sth, @bind) = $self->_select(@_);
2495 my @row = $sth->fetchrow_array;
2496 my @nextrow = $sth->fetchrow_array if @row;
2497 if(@row && @nextrow) {
2498 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2500 # Need to call finish() to work round broken DBDs
2505 =head2 sql_limit_dialect
2507 This is an accessor for the default SQL limit dialect used by a particular
2508 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2509 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2510 see L<DBIx::Class::SQLMaker::LimitDialects>.
2514 sub _dbh_columns_info_for {
2515 my ($self, $dbh, $table) = @_;
2517 if ($dbh->can('column_info')) {
2521 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2522 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2524 while ( my $info = $sth->fetchrow_hashref() ){
2526 $column_info{data_type} = $info->{TYPE_NAME};
2527 $column_info{size} = $info->{COLUMN_SIZE};
2528 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2529 $column_info{default_value} = $info->{COLUMN_DEF};
2530 my $col_name = $info->{COLUMN_NAME};
2531 $col_name =~ s/^\"(.*)\"$/$1/;
2533 $result{$col_name} = \%column_info;
2538 return \%result if !$caught && scalar keys %result;
2542 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2544 my @columns = @{$sth->{NAME_lc}};
2545 for my $i ( 0 .. $#columns ){
2547 $column_info{data_type} = $sth->{TYPE}->[$i];
2548 $column_info{size} = $sth->{PRECISION}->[$i];
2549 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2551 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2552 $column_info{data_type} = $1;
2553 $column_info{size} = $2;
2556 $result{$columns[$i]} = \%column_info;
2560 foreach my $col (keys %result) {
2561 my $colinfo = $result{$col};
2562 my $type_num = $colinfo->{data_type};
2564 if(defined $type_num && $dbh->can('type_info')) {
2565 my $type_info = $dbh->type_info($type_num);
2566 $type_name = $type_info->{TYPE_NAME} if $type_info;
2567 $colinfo->{data_type} = $type_name if $type_name;
2574 sub columns_info_for {
2575 my ($self, $table) = @_;
2576 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2579 =head2 last_insert_id
2581 Return the row id of the last insert.
2585 sub _dbh_last_insert_id {
2586 my ($self, $dbh, $source, $col) = @_;
2588 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2590 return $id if defined $id;
2592 my $class = ref $self;
2593 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2596 sub last_insert_id {
2598 $self->_dbh_last_insert_id ($self->_dbh, @_);
2601 =head2 _native_data_type
2605 =item Arguments: $type_name
2609 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2610 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2611 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2613 The default implementation returns C<undef>, implement in your Storage driver if
2614 you need this functionality.
2616 Should map types from other databases to the native RDBMS type, for example
2617 C<VARCHAR2> to C<VARCHAR>.
2619 Types with modifiers should map to the underlying data type. For example,
2620 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2622 Composite types should map to the container type, for example
2623 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2627 sub _native_data_type {
2628 #my ($self, $data_type) = @_;
2632 # Check if placeholders are supported at all
2633 sub _determine_supports_placeholders {
2635 my $dbh = $self->_get_dbh;
2637 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2638 # but it is inaccurate more often than not
2640 local $dbh->{PrintError} = 0;
2641 local $dbh->{RaiseError} = 1;
2642 $dbh->do('select ?', {}, 1);
2650 # Check if placeholders bound to non-string types throw exceptions
2652 sub _determine_supports_typeless_placeholders {
2654 my $dbh = $self->_get_dbh;
2657 local $dbh->{PrintError} = 0;
2658 local $dbh->{RaiseError} = 1;
2659 # this specifically tests a bind that is NOT a string
2660 $dbh->do('select 1 where 1 = ?', {}, 1);
2670 Returns the database driver name.
2675 shift->_get_dbh->{Driver}->{Name};
2678 =head2 bind_attribute_by_data_type
2680 Given a datatype from column info, returns a database specific bind
2681 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2682 let the database planner just handle it.
2684 This method is always called after the driver has been determined and a DBI
2685 connection has been established. Therefore you can refer to C<DBI::$constant>
2686 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2687 the correct modules.
2691 sub bind_attribute_by_data_type {
2695 =head2 is_datatype_numeric
2697 Given a datatype from column_info, returns a boolean value indicating if
2698 the current RDBMS considers it a numeric value. This controls how
2699 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2700 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2701 be performed instead of the usual C<eq>.
2705 sub is_datatype_numeric {
2706 #my ($self, $dt) = @_;
2708 return 0 unless $_[1];
2711 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2716 =head2 create_ddl_dir
2720 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2724 Creates a SQL file based on the Schema, for each of the specified
2725 database engines in C<\@databases> in the given directory.
2726 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2728 Given a previous version number, this will also create a file containing
2729 the ALTER TABLE statements to transform the previous schema into the
2730 current one. Note that these statements may contain C<DROP TABLE> or
2731 C<DROP COLUMN> statements that can potentially destroy data.
2733 The file names are created using the C<ddl_filename> method below, please
2734 override this method in your schema if you would like a different file
2735 name format. For the ALTER file, the same format is used, replacing
2736 $version in the name with "$preversion-$version".
2738 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2739 The most common value for this would be C<< { add_drop_table => 1 } >>
2740 to have the SQL produced include a C<DROP TABLE> statement for each table
2741 created. For quoting purposes supply C<quote_identifiers>.
2743 If no arguments are passed, then the following default values are assumed:
2747 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2749 =item version - $schema->schema_version
2751 =item directory - './'
2753 =item preversion - <none>
2757 By default, C<\%sqlt_args> will have
2759 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2761 merged with the hash passed in. To disable any of those features, pass in a
2762 hashref like the following
2764 { ignore_constraint_names => 0, # ... other options }
2767 WARNING: You are strongly advised to check all SQL files created, before applying
2772 sub create_ddl_dir {
2773 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2776 carp "No directory given, using ./\n";
2781 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2783 $self->throw_exception(
2784 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2788 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2790 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2791 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2793 my $schema_version = $schema->schema_version || '1.x';
2794 $version ||= $schema_version;
2797 add_drop_table => 1,
2798 ignore_constraint_names => 1,
2799 ignore_index_names => 1,
2803 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2804 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2807 my $sqlt = SQL::Translator->new( $sqltargs );
2809 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2810 my $sqlt_schema = $sqlt->translate({ data => $schema })
2811 or $self->throw_exception ($sqlt->error);
2813 foreach my $db (@$databases) {
2815 $sqlt->{schema} = $sqlt_schema;
2816 $sqlt->producer($db);
2819 my $filename = $schema->ddl_filename($db, $version, $dir);
2820 if (-e $filename && ($version eq $schema_version )) {
2821 # if we are dumping the current version, overwrite the DDL
2822 carp "Overwriting existing DDL file - $filename";
2826 my $output = $sqlt->translate;
2828 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2831 if(!open($file, ">$filename")) {
2832 $self->throw_exception("Can't open $filename for writing ($!)");
2835 print $file $output;
2838 next unless ($preversion);
2840 require SQL::Translator::Diff;
2842 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2843 if(!-e $prefilename) {
2844 carp("No previous schema file found ($prefilename)");
2848 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2850 carp("Overwriting existing diff file - $difffile");
2856 my $t = SQL::Translator->new($sqltargs);
2861 or $self->throw_exception ($t->error);
2863 my $out = $t->translate( $prefilename )
2864 or $self->throw_exception ($t->error);
2866 $source_schema = $t->schema;
2868 $source_schema->name( $prefilename )
2869 unless ( $source_schema->name );
2872 # The "new" style of producers have sane normalization and can support
2873 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2874 # And we have to diff parsed SQL against parsed SQL.
2875 my $dest_schema = $sqlt_schema;
2877 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2878 my $t = SQL::Translator->new($sqltargs);
2883 or $self->throw_exception ($t->error);
2885 my $out = $t->translate( $filename )
2886 or $self->throw_exception ($t->error);
2888 $dest_schema = $t->schema;
2890 $dest_schema->name( $filename )
2891 unless $dest_schema->name;
2894 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2898 if(!open $file, ">$difffile") {
2899 $self->throw_exception("Can't write to $difffile ($!)");
2907 =head2 deployment_statements
2911 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2915 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2917 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2918 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2920 C<$directory> is used to return statements from files in a previously created
2921 L</create_ddl_dir> directory and is optional. The filenames are constructed
2922 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2924 If no C<$directory> is specified then the statements are constructed on the
2925 fly using L<SQL::Translator> and C<$version> is ignored.
2927 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2931 sub deployment_statements {
2932 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2933 $type ||= $self->sqlt_type;
2934 $version ||= $schema->schema_version || '1.x';
2936 my $filename = $schema->ddl_filename($type, $version, $dir);
2939 # FIXME replace this block when a proper sane sql parser is available
2941 open($file, "<$filename")
2942 or $self->throw_exception("Can't open $filename ($!)");
2945 return join('', @rows);
2948 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2949 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2952 # sources needs to be a parser arg, but for simplicity allow at top level
2954 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2955 if exists $sqltargs->{sources};
2957 my $tr = SQL::Translator->new(
2958 producer => "SQL::Translator::Producer::${type}",
2960 parser => 'SQL::Translator::Parser::DBIx::Class',
2964 return preserve_context {
2967 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2968 unless defined $_[0];
2972 # FIXME deploy() currently does not accurately report sql errors
2973 # Will always return true while errors are warned
2975 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2979 return if($line =~ /^--/);
2980 # next if($line =~ /^DROP/m);
2981 return if($line =~ /^BEGIN TRANSACTION/m);
2982 return if($line =~ /^COMMIT/m);
2983 return if $line =~ /^\s+$/; # skip whitespace only
2984 $self->_query_start($line);
2986 # do a dbh_do cycle here, as we need some error checking in
2987 # place (even though we will ignore errors)
2988 $self->dbh_do (sub { $_[1]->do($line) });
2990 carp qq{$_ (running "${line}")};
2992 $self->_query_end($line);
2994 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2995 if (@statements > 1) {
2996 foreach my $statement (@statements) {
2997 $deploy->( $statement );
3000 elsif (@statements == 1) {
3001 # split on single line comments and end of statements
3002 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
3008 =head2 datetime_parser
3010 Returns the datetime parser class
3014 sub datetime_parser {
3016 return $self->{datetime_parser} ||= do {
3017 $self->build_datetime_parser(@_);
3021 =head2 datetime_parser_type
3023 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
3025 =head2 build_datetime_parser
3027 See L</datetime_parser>
3031 sub build_datetime_parser {
3033 my $type = $self->datetime_parser_type(@_);
3038 =head2 is_replicating
3040 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3041 replicate from a master database. Default is undef, which is the result
3042 returned by databases that don't support replication.
3046 sub is_replicating {
3051 =head2 lag_behind_master
3053 Returns a number that represents a certain amount of lag behind a master db
3054 when a given storage is replicating. The number is database dependent, but
3055 starts at zero and increases with the amount of lag. Default in undef
3059 sub lag_behind_master {
3063 =head2 relname_to_table_alias
3067 =item Arguments: $relname, $join_count
3069 =item Return Value: $alias
3073 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3076 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3077 way these aliases are named.
3079 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3080 otherwise C<"$relname">.
3084 sub relname_to_table_alias {
3085 my ($self, $relname, $join_count) = @_;
3087 my $alias = ($join_count && $join_count > 1 ?
3088 join('_', $relname, $join_count) : $relname);
3093 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3094 # version and it may be necessary to amend or override it for a specific storage
3095 # if such binds are necessary.
3096 sub _max_column_bytesize {
3097 my ($self, $attr) = @_;
3101 if ($attr->{sqlt_datatype}) {
3102 my $data_type = lc($attr->{sqlt_datatype});
3104 if ($attr->{sqlt_size}) {
3106 # String/sized-binary types
3107 if ($data_type =~ /^(?:
3108 l? (?:var)? char(?:acter)? (?:\s*varying)?
3110 (?:var)? binary (?:\s*varying)?
3115 $max_size = $attr->{sqlt_size};
3117 # Other charset/unicode types, assume scale of 4
3118 elsif ($data_type =~ /^(?:
3119 national \s* character (?:\s*varying)?
3128 $max_size = $attr->{sqlt_size} * 4;
3132 if (!$max_size and !$self->_is_lob_type($data_type)) {
3133 $max_size = 100 # for all other (numeric?) datatypes
3137 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3140 # Determine if a data_type is some type of BLOB
3142 my ($self, $data_type) = @_;
3143 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3144 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3145 |varchar|character\s*varying|nvarchar
3146 |national\s*character\s*varying))?\z/xi);
3149 sub _is_binary_lob_type {
3150 my ($self, $data_type) = @_;
3151 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3152 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3155 sub _is_text_lob_type {
3156 my ($self, $data_type) = @_;
3157 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3158 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3159 |national\s*character\s*varying))\z/xi);
3162 # Determine if a data_type is some type of a binary type
3163 sub _is_binary_type {
3164 my ($self, $data_type) = @_;
3165 $data_type && ($self->_is_binary_lob_type($data_type)
3166 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3173 =head2 DBIx::Class and AutoCommit
3175 DBIx::Class can do some wonderful magic with handling exceptions,
3176 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3177 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3178 transaction support.
3180 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3181 in an assumed transaction between commits, and you're telling us you'd
3182 like to manage that manually. A lot of the magic protections offered by
3183 this module will go away. We can't protect you from exceptions due to database
3184 disconnects because we don't know anything about how to restart your
3185 transactions. You're on your own for handling all sorts of exceptional
3186 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3190 =head1 AUTHOR AND CONTRIBUTORS
3192 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3196 You may distribute this code under the same terms as Perl itself.