1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
4 use base 'DBIx::Class::Storage';
8 use Carp::Clan qw/^DBIx::Class/;
10 use DBIx::Class::Storage::DBI::Cursor;
11 use DBIx::Class::Storage::Statistics;
15 __PACKAGE__->mk_group_accessors('simple' =>
16 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts
17 _conn_pid _conn_tid transaction_depth _dbh_autocommit _on_connect_do
18 _on_disconnect_do __on_connect_do __on_disconnect_do savepoints/
21 # the values for these accessors are picked out (and deleted) from
22 # the attribute hashref passed to connect_info
23 my @storage_options = qw/
24 on_connect_call on_disconnect_call disable_sth_caching unsafe auto_savepoint
26 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
29 # default cursor class, overridable in connect_info attributes
30 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
32 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
33 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
38 DBIx::Class::Storage::DBI - DBI storage handler
42 my $schema = MySchema->connect('dbi:SQLite:my.db');
44 $schema->storage->debug(1);
45 $schema->dbh_do("DROP TABLE authors");
47 $schema->resultset('Book')->search({
48 written_on => $schema->storage->datetime_parser(DateTime->now)
53 This class represents the connection to an RDBMS via L<DBI>. See
54 L<DBIx::Class::Storage> for general information. This pod only
55 documents DBI-specific methods and behaviors.
62 my $new = shift->next::method(@_);
64 $new->transaction_depth(0);
65 $new->_sql_maker_opts({});
66 $new->{savepoints} = [];
67 $new->{_in_dbh_do} = 0;
75 This method is normally called by L<DBIx::Class::Schema/connection>, which
76 encapsulates its argument list in an arrayref before passing them here.
78 The argument list may contain:
84 The same 4-element argument set one would normally pass to
85 L<DBI/connect>, optionally followed by
86 L<extra attributes|/DBIx::Class specific connection attributes>
87 recognized by DBIx::Class:
89 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
93 A single code reference which returns a connected
94 L<DBI database handle|DBI/connect> optionally followed by
95 L<extra attributes|/DBIx::Class specific connection attributes> recognized
98 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
102 A single hashref with all the attributes and the dsn/user/password
105 $connect_info_args = [{
113 This is particularly useful for L<Catalyst> based applications, allowing the
114 following config (L<Config::General> style):
119 dsn dbi:mysql:database=test
128 Please note that the L<DBI> docs recommend that you always explicitly
129 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
130 recommends that it be set to I<1>, and that you perform transactions
131 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
132 to I<1> if you do not do explicitly set it to zero. This is the default
133 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
135 =head3 DBIx::Class specific connection attributes
137 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
138 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
139 the following connection options. These options can be mixed in with your other
140 L<DBI> connection attributes, or placed in a seperate hashref
141 (C<\%extra_attributes>) as shown above.
143 Every time C<connect_info> is invoked, any previous settings for
144 these options will be cleared before setting the new ones, regardless of
145 whether any options are specified in the new C<connect_info>.
152 Specifies things to do immediately after connecting or re-connecting to
153 the database. Its value may contain:
159 This contains one SQL statement to execute.
161 =item an array reference
163 This contains SQL statements to execute in order. Each element contains
164 a string or a code reference that returns a string.
166 =item a code reference
168 This contains some code to execute. Unlike code references within an
169 array reference, its return value is ignored.
173 =item on_disconnect_do
175 Takes arguments in the same form as L</on_connect_do> and executes them
176 immediately before disconnecting from the database.
178 Note, this only runs if you explicitly call L</disconnect> on the
181 =item on_connect_call
183 A more generalized form of L</on_connect_do> that calls the specified
184 C<connect_call_METHOD> methods in your storage driver.
186 on_connect_do => 'select 1'
190 on_connect_call => [ [ do_sql => 'select 1' ] ]
192 Its values may contain:
198 Will call the C<connect_call_METHOD> method.
200 =item a code reference
202 Will execute C<< $code->($storage) >>
204 =item an array reference
206 Each value can be a method name or code reference.
208 =item an array of arrays
210 For each array, the first item is taken to be the C<connect_call_> method name
211 or code reference, and the rest are parameters to it.
215 Some predefined storage methods you may use:
221 Executes a SQL string or a code reference that returns a SQL string. This is
222 what L</on_connect_do> and L</on_disconnect_do> use.
230 Will execute the scalar as SQL.
234 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
235 attributes hashref and bind values.
237 =item a code reference
239 Will execute C<< $code->($storage) >> and execute the return array refs as
246 Execute any statements necessary to initialize the database session to return
247 and accept datetime/timestamp values used with
248 L<DBIx::Class::InflateColumn::DateTime>.
250 Only necessary for some databases, see your specific storage driver for
251 implementation details.
255 =item on_disconnect_call
257 Takes arguments in the same form as L</on_connect_call> and executes them
258 immediately before disconnecting from the database.
260 Calls the C<disconnect_call_METHOD> methods as opposed to the
261 C<connect_call_METHOD> methods called by L</on_connect_call>.
263 Note, this only runs if you explicitly call L</disconnect> on the
266 =item disable_sth_caching
268 If set to a true value, this option will disable the caching of
269 statement handles via L<DBI/prepare_cached>.
273 Sets the limit dialect. This is useful for JDBC-bridge among others
274 where the remote SQL-dialect cannot be determined by the name of the
275 driver alone. See also L<SQL::Abstract::Limit>.
279 Specifies what characters to use to quote table and column names. If
280 you use this you will want to specify L</name_sep> as well.
282 C<quote_char> expects either a single character, in which case is it
283 is placed on either side of the table/column name, or an arrayref of length
284 2 in which case the table/column name is placed between the elements.
286 For example under MySQL you should use C<< quote_char => '`' >>, and for
287 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
291 This only needs to be used in conjunction with C<quote_char>, and is used to
292 specify the charecter that seperates elements (schemas, tables, columns) from
293 each other. In most cases this is simply a C<.>.
295 The consequences of not supplying this value is that L<SQL::Abstract>
296 will assume DBIx::Class' uses of aliases to be complete column
297 names. The output will look like I<"me.name"> when it should actually
302 This Storage driver normally installs its own C<HandleError>, sets
303 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
304 all database handles, including those supplied by a coderef. It does this
305 so that it can have consistent and useful error behavior.
307 If you set this option to a true value, Storage will not do its usual
308 modifications to the database handle's attributes, and instead relies on
309 the settings in your connect_info DBI options (or the values you set in
310 your connection coderef, in the case that you are connecting via coderef).
312 Note that your custom settings can cause Storage to malfunction,
313 especially if you set a C<HandleError> handler that suppresses exceptions
314 and/or disable C<RaiseError>.
318 If this option is true, L<DBIx::Class> will use savepoints when nesting
319 transactions, making it possible to recover from failure in the inner
320 transaction without having to abort all outer transactions.
324 Use this argument to supply a cursor class other than the default
325 L<DBIx::Class::Storage::DBI::Cursor>.
329 Some real-life examples of arguments to L</connect_info> and
330 L<DBIx::Class::Schema/connect>
332 # Simple SQLite connection
333 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
336 ->connect_info([ sub { DBI->connect(...) } ]);
338 # A bit more complicated
345 { quote_char => q{"}, name_sep => q{.} },
349 # Equivalent to the previous example
355 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
359 # Same, but with hashref as argument
360 # See parse_connect_info for explanation
363 dsn => 'dbi:Pg:dbname=foo',
365 password => 'my_pg_password',
372 # Subref + DBIx::Class-specific connection options
375 sub { DBI->connect(...) },
379 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
380 disable_sth_caching => 1,
390 my ($self, $info_arg) = @_;
392 return $self->_connect_info if !$info_arg;
394 my @args = @$info_arg; # take a shallow copy for further mutilation
395 $self->_connect_info([@args]); # copy for _connect_info
398 # combine/pre-parse arguments depending on invocation style
401 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
402 %attrs = %{ $args[1] || {} };
405 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
406 %attrs = %{$args[0]};
408 for (qw/password user dsn/) {
409 unshift @args, delete $attrs{$_};
412 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
414 % { $args[3] || {} },
415 % { $args[4] || {} },
417 @args = @args[0,1,2];
420 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
421 # the new set of options
422 $self->_sql_maker(undef);
423 $self->_sql_maker_opts({});
426 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
427 if(my $value = delete $attrs{$storage_opt}) {
428 $self->$storage_opt($value);
431 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
432 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
433 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
436 for my $connect_do_opt (qw/on_connect_do on_disconnect_do/) {
437 if(my $opt_val = delete $attrs{$connect_do_opt}) {
438 $self->$connect_do_opt($opt_val);
443 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
445 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
446 $self->_connect_info;
451 This method is deprecated in favour of setting via L</connect_info>.
457 $self->_setup_connect_do(on_connect_do => @_);
460 =head2 on_disconnect_do
462 This method is deprecated in favour of setting via L</connect_info>.
466 sub on_disconnect_do {
468 $self->_setup_connect_do(on_disconnect_do => @_);
471 sub _setup_connect_do {
472 my ($self, $opt) = (shift, shift);
474 my $accessor = "_$opt";
475 my $store = "__$opt";
477 return $self->$accessor if not @_;
481 $self->throw_exception("The value of $opt cannot be 'undef'")
487 push @store, [ 'do_sql', $val ];
488 } elsif (ref($val) eq 'CODE') {
490 } elsif (ref($val) eq 'ARRAY') {
491 push @store, map [ 'do_sql', $_ ], @$val;
493 $self->throw_exception("Invalid type for $opt ".ref($val));
496 $self->$store(\@store);
497 $self->$accessor($val);
502 Arguments: ($subref | $method_name), @extra_coderef_args?
504 Execute the given $subref or $method_name using the new exception-based
505 connection management.
507 The first two arguments will be the storage object that C<dbh_do> was called
508 on and a database handle to use. Any additional arguments will be passed
509 verbatim to the called subref as arguments 2 and onwards.
511 Using this (instead of $self->_dbh or $self->dbh) ensures correct
512 exception handling and reconnection (or failover in future subclasses).
514 Your subref should have no side-effects outside of the database, as
515 there is the potential for your subref to be partially double-executed
516 if the database connection was stale/dysfunctional.
520 my @stuff = $schema->storage->dbh_do(
522 my ($storage, $dbh, @cols) = @_;
523 my $cols = join(q{, }, @cols);
524 $dbh->selectrow_array("SELECT $cols FROM foo");
535 my $dbh = $self->_dbh;
537 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
538 || $self->{transaction_depth};
540 local $self->{_in_dbh_do} = 1;
543 my $want_array = wantarray;
546 $self->_verify_pid if $dbh;
548 $self->_populate_dbh;
553 @result = $self->$code($dbh, @_);
555 elsif(defined $want_array) {
556 $result[0] = $self->$code($dbh, @_);
559 $self->$code($dbh, @_);
564 if(!$exception) { return $want_array ? @result : $result[0] }
566 $self->throw_exception($exception) if $self->connected;
568 # We were not connected - reconnect and retry, but let any
569 # exception fall right through this time
570 $self->_populate_dbh;
571 $self->$code($self->_dbh, @_);
574 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
575 # It also informs dbh_do to bypass itself while under the direction of txn_do,
576 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
581 ref $coderef eq 'CODE' or $self->throw_exception
582 ('$coderef must be a CODE reference');
584 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
586 local $self->{_in_dbh_do} = 1;
589 my $want_array = wantarray;
594 $self->_verify_pid if $self->_dbh;
595 $self->_populate_dbh if !$self->_dbh;
599 @result = $coderef->(@_);
601 elsif(defined $want_array) {
602 $result[0] = $coderef->(@_);
611 if(!$exception) { return $want_array ? @result : $result[0] }
613 if($tried++ > 0 || $self->connected) {
614 eval { $self->txn_rollback };
615 my $rollback_exception = $@;
616 if($rollback_exception) {
617 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
618 $self->throw_exception($exception) # propagate nested rollback
619 if $rollback_exception =~ /$exception_class/;
621 $self->throw_exception(
622 "Transaction aborted: ${exception}. "
623 . "Rollback failed: ${rollback_exception}"
626 $self->throw_exception($exception)
629 # We were not connected, and was first try - reconnect and retry
631 $self->_populate_dbh;
637 Our C<disconnect> method also performs a rollback first if the
638 database is not in C<AutoCommit> mode.
645 if( $self->connected ) {
646 if (my $connection_call = $self->on_disconnect_call) {
647 $self->_do_connection_actions(disconnect_call_ => $connection_call)
649 if (my $connection_do = $self->__on_disconnect_do) {
650 $self->_do_connection_actions(disconnect_call_ => $connection_do)
653 $self->_dbh->rollback unless $self->_dbh_autocommit;
654 $self->_dbh->disconnect;
660 =head2 with_deferred_fk_checks
664 =item Arguments: C<$coderef>
666 =item Return Value: The return value of $coderef
670 Storage specific method to run the code ref with FK checks deferred or
671 in MySQL's case disabled entirely.
675 # Storage subclasses should override this
676 sub with_deferred_fk_checks {
677 my ($self, $sub) = @_;
685 if(my $dbh = $self->_dbh) {
686 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
693 return 0 if !$self->_dbh;
695 return ($dbh->FETCH('Active') && $dbh->ping);
701 # handle pid changes correctly
702 # NOTE: assumes $self->_dbh is a valid $dbh
706 return if defined $self->_conn_pid && $self->_conn_pid == $$;
708 $self->_dbh->{InactiveDestroy} = 1;
715 sub ensure_connected {
718 unless ($self->connected) {
719 $self->_populate_dbh;
725 Returns the dbh - a data base handle of class L<DBI>.
732 $self->ensure_connected;
736 sub _sql_maker_args {
739 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
744 unless ($self->_sql_maker) {
745 my $sql_maker_class = $self->sql_maker_class;
746 $self->ensure_class_loaded ($sql_maker_class);
747 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
749 return $self->_sql_maker;
756 my @info = @{$self->_dbi_connect_info || []};
757 $self->_dbh($self->_connect(@info));
759 $self->_conn_pid($$);
760 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
762 $self->_determine_driver;
764 # Always set the transaction depth on connect, since
765 # there is no transaction in progress by definition
766 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
768 if (my $connection_call = $self->on_connect_call) {
769 $self->_do_connection_actions(connect_call_ => $connection_call)
771 if (my $connection_do = $self->__on_connect_do) {
772 $self->_do_connection_actions(connect_call_ => $connection_do)
776 sub _determine_driver {
779 if (ref $self eq 'DBIx::Class::Storage::DBI') {
782 if ($self->_dbh) { # we are connected
783 $driver = $self->_dbh->{Driver}{Name};
785 # try to use dsn to not require being connected, the driver may still
786 # force a connection in _rebless to determine version
787 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
790 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
791 bless $self, "DBIx::Class::Storage::DBI::${driver}";
797 sub _do_connection_actions {
799 my $method_prefix = shift;
802 if (not ref($call)) {
803 my $method = $method_prefix . $call;
805 } elsif (ref($call) eq 'CODE') {
807 } elsif (ref($call) eq 'ARRAY') {
808 if (ref($call->[0]) ne 'ARRAY') {
809 $self->_do_connection_actions($method_prefix, $_) for @$call;
811 $self->_do_connection_actions($method_prefix, @$_) for @$call;
814 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
820 sub connect_call_do_sql {
822 $self->_do_query(@_);
825 sub disconnect_call_do_sql {
827 $self->_do_query(@_);
830 # override in db-specific backend when necessary
831 sub connect_call_datetime_setup { 1 }
834 my ($self, $action) = @_;
836 if (ref $action eq 'CODE') {
837 $action = $action->($self);
838 $self->_do_query($_) foreach @$action;
841 # Most debuggers expect ($sql, @bind), so we need to exclude
842 # the attribute hash which is the second argument to $dbh->do
843 # furthermore the bind values are usually to be presented
844 # as named arrayref pairs, so wrap those here too
845 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
846 my $sql = shift @do_args;
847 my $attrs = shift @do_args;
848 my @bind = map { [ undef, $_ ] } @do_args;
850 $self->_query_start($sql, @bind);
851 $self->_dbh->do($sql, $attrs, @do_args);
852 $self->_query_end($sql, @bind);
859 my ($self, @info) = @_;
861 $self->throw_exception("You failed to provide any connection info")
864 my ($old_connect_via, $dbh);
866 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
867 $old_connect_via = $DBI::connect_via;
868 $DBI::connect_via = 'connect';
872 if(ref $info[0] eq 'CODE') {
876 $dbh = DBI->connect(@info);
879 if($dbh && !$self->unsafe) {
880 my $weak_self = $self;
881 Scalar::Util::weaken($weak_self);
882 $dbh->{HandleError} = sub {
884 $weak_self->throw_exception("DBI Exception: $_[0]");
887 croak ("DBI Exception: $_[0]");
890 $dbh->{ShowErrorStatement} = 1;
891 $dbh->{RaiseError} = 1;
892 $dbh->{PrintError} = 0;
896 $DBI::connect_via = $old_connect_via if $old_connect_via;
898 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
901 $self->_dbh_autocommit($dbh->{AutoCommit});
907 my ($self, $name) = @_;
909 $name = $self->_svp_generate_name
910 unless defined $name;
912 $self->throw_exception ("You can't use savepoints outside a transaction")
913 if $self->{transaction_depth} == 0;
915 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
916 unless $self->can('_svp_begin');
918 push @{ $self->{savepoints} }, $name;
920 $self->debugobj->svp_begin($name) if $self->debug;
922 return $self->_svp_begin($name);
926 my ($self, $name) = @_;
928 $self->throw_exception ("You can't use savepoints outside a transaction")
929 if $self->{transaction_depth} == 0;
931 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
932 unless $self->can('_svp_release');
935 $self->throw_exception ("Savepoint '$name' does not exist")
936 unless grep { $_ eq $name } @{ $self->{savepoints} };
938 # Dig through the stack until we find the one we are releasing. This keeps
939 # the stack up to date.
942 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
944 $name = pop @{ $self->{savepoints} };
947 $self->debugobj->svp_release($name) if $self->debug;
949 return $self->_svp_release($name);
953 my ($self, $name) = @_;
955 $self->throw_exception ("You can't use savepoints outside a transaction")
956 if $self->{transaction_depth} == 0;
958 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
959 unless $self->can('_svp_rollback');
962 # If they passed us a name, verify that it exists in the stack
963 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
964 $self->throw_exception("Savepoint '$name' does not exist!");
967 # Dig through the stack until we find the one we are releasing. This keeps
968 # the stack up to date.
969 while(my $s = pop(@{ $self->{savepoints} })) {
970 last if($s eq $name);
972 # Add the savepoint back to the stack, as a rollback doesn't remove the
973 # named savepoint, only everything after it.
974 push(@{ $self->{savepoints} }, $name);
976 # We'll assume they want to rollback to the last savepoint
977 $name = $self->{savepoints}->[-1];
980 $self->debugobj->svp_rollback($name) if $self->debug;
982 return $self->_svp_rollback($name);
985 sub _svp_generate_name {
988 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
993 $self->ensure_connected();
994 if($self->{transaction_depth} == 0) {
995 $self->debugobj->txn_begin()
997 # this isn't ->_dbh-> because
998 # we should reconnect on begin_work
999 # for AutoCommit users
1000 $self->dbh->begin_work;
1001 } elsif ($self->auto_savepoint) {
1004 $self->{transaction_depth}++;
1009 if ($self->{transaction_depth} == 1) {
1010 my $dbh = $self->_dbh;
1011 $self->debugobj->txn_commit()
1014 $self->{transaction_depth} = 0
1015 if $self->_dbh_autocommit;
1017 elsif($self->{transaction_depth} > 1) {
1018 $self->{transaction_depth}--;
1020 if $self->auto_savepoint;
1026 my $dbh = $self->_dbh;
1028 if ($self->{transaction_depth} == 1) {
1029 $self->debugobj->txn_rollback()
1031 $self->{transaction_depth} = 0
1032 if $self->_dbh_autocommit;
1035 elsif($self->{transaction_depth} > 1) {
1036 $self->{transaction_depth}--;
1037 if ($self->auto_savepoint) {
1038 $self->svp_rollback;
1043 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1048 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1049 $error =~ /$exception_class/ and $self->throw_exception($error);
1050 # ensure that a failed rollback resets the transaction depth
1051 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1052 $self->throw_exception($error);
1056 # This used to be the top-half of _execute. It was split out to make it
1057 # easier to override in NoBindVars without duping the rest. It takes up
1058 # all of _execute's args, and emits $sql, @bind.
1059 sub _prep_for_execute {
1060 my ($self, $op, $extra_bind, $ident, $args) = @_;
1062 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1063 $ident = $ident->from();
1066 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1069 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1071 return ($sql, \@bind);
1075 sub _fix_bind_params {
1076 my ($self, @bind) = @_;
1078 ### Turn @bind from something like this:
1079 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1081 ### ( "'1'", "'1'", "'3'" )
1084 if ( defined( $_ && $_->[1] ) ) {
1085 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1092 my ( $self, $sql, @bind ) = @_;
1094 if ( $self->debug ) {
1095 @bind = $self->_fix_bind_params(@bind);
1097 $self->debugobj->query_start( $sql, @bind );
1102 my ( $self, $sql, @bind ) = @_;
1104 if ( $self->debug ) {
1105 @bind = $self->_fix_bind_params(@bind);
1106 $self->debugobj->query_end( $sql, @bind );
1111 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1113 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1115 $self->_query_start( $sql, @$bind );
1117 my $sth = $self->sth($sql,$op);
1119 my $placeholder_index = 1;
1121 foreach my $bound (@$bind) {
1122 my $attributes = {};
1123 my($column_name, @data) = @$bound;
1125 if ($bind_attributes) {
1126 $attributes = $bind_attributes->{$column_name}
1127 if defined $bind_attributes->{$column_name};
1130 foreach my $data (@data) {
1131 my $ref = ref $data;
1132 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1134 $sth->bind_param($placeholder_index, $data, $attributes);
1135 $placeholder_index++;
1139 # Can this fail without throwing an exception anyways???
1140 my $rv = $sth->execute();
1141 $self->throw_exception($sth->errstr) if !$rv;
1143 $self->_query_end( $sql, @$bind );
1145 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1150 $self->dbh_do('_dbh_execute', @_)
1154 my ($self, $source, $to_insert) = @_;
1156 my $ident = $source->from;
1157 my $bind_attributes = $self->source_bind_attributes($source);
1159 my $updated_cols = {};
1161 $self->ensure_connected;
1162 foreach my $col ( $source->columns ) {
1163 if ( !defined $to_insert->{$col} ) {
1164 my $col_info = $source->column_info($col);
1166 if ( $col_info->{auto_nextval} ) {
1167 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1172 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1174 return $updated_cols;
1177 ## Still not quite perfect, and EXPERIMENTAL
1178 ## Currently it is assumed that all values passed will be "normal", i.e. not
1179 ## scalar refs, or at least, all the same type as the first set, the statement is
1180 ## only prepped once.
1182 my ($self, $source, $cols, $data) = @_;
1184 my $table = $source->from;
1185 @colvalues{@$cols} = (0..$#$cols);
1186 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1188 $self->_query_start( $sql, @bind );
1189 my $sth = $self->sth($sql);
1191 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1193 ## This must be an arrayref, else nothing works!
1194 my $tuple_status = [];
1196 ## Get the bind_attributes, if any exist
1197 my $bind_attributes = $self->source_bind_attributes($source);
1199 ## Bind the values and execute
1200 my $placeholder_index = 1;
1202 foreach my $bound (@bind) {
1204 my $attributes = {};
1205 my ($column_name, $data_index) = @$bound;
1207 if( $bind_attributes ) {
1208 $attributes = $bind_attributes->{$column_name}
1209 if defined $bind_attributes->{$column_name};
1212 my @data = map { $_->[$data_index] } @$data;
1214 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1215 $placeholder_index++;
1217 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1220 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1222 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1223 if ($i > $#$tuple_status);
1225 require Data::Dumper;
1226 local $Data::Dumper::Terse = 1;
1227 local $Data::Dumper::Indent = 1;
1228 local $Data::Dumper::Useqq = 1;
1229 local $Data::Dumper::Quotekeys = 0;
1231 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1232 $tuple_status->[$i][1],
1233 Data::Dumper::Dumper(
1234 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1238 $self->throw_exception($sth->errstr) if !$rv;
1240 $self->_query_end( $sql, @bind );
1241 return (wantarray ? ($rv, $sth, @bind) : $rv);
1245 my $self = shift @_;
1246 my $source = shift @_;
1247 my $bind_attributes = $self->source_bind_attributes($source);
1249 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1254 my $self = shift @_;
1255 my $source = shift @_;
1257 my $bind_attrs = $self->source_bind_attributes($source);
1259 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1262 # We were sent here because the $rs contains a complex search
1263 # which will require a subquery to select the correct rows
1264 # (i.e. joined or limited resultsets)
1266 # Genarating a single PK column subquery is trivial and supported
1267 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1268 # Look at _multipk_update_delete()
1269 sub _subq_update_delete {
1271 my ($rs, $op, $values) = @_;
1273 my $rsrc = $rs->result_source;
1275 # we already check this, but double check naively just in case. Should be removed soon
1276 my $sel = $rs->_resolved_attrs->{select};
1277 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1278 my @pcols = $rsrc->primary_columns;
1279 if (@$sel != @pcols) {
1280 $self->throw_exception (
1281 'Subquery update/delete can not be called on resultsets selecting a'
1282 .' number of columns different than the number of primary keys'
1289 $op eq 'update' ? $values : (),
1290 { $pcols[0] => { -in => $rs->as_query } },
1295 return $self->_multipk_update_delete (@_);
1299 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1300 # resultset update/delete involving subqueries. So by default resort
1301 # to simple (and inefficient) delete_all style per-row opearations,
1302 # while allowing specific storages to override this with a faster
1305 sub _multipk_update_delete {
1306 return shift->_per_row_update_delete (@_);
1309 # This is the default loop used to delete/update rows for multi PK
1310 # resultsets, and used by mysql exclusively (because it can't do anything
1313 # We do not use $row->$op style queries, because resultset update/delete
1314 # is not expected to cascade (this is what delete_all/update_all is for).
1316 # There should be no race conditions as the entire operation is rolled
1319 sub _per_row_update_delete {
1321 my ($rs, $op, $values) = @_;
1323 my $rsrc = $rs->result_source;
1324 my @pcols = $rsrc->primary_columns;
1326 my $guard = $self->txn_scope_guard;
1328 # emulate the return value of $sth->execute for non-selects
1329 my $row_cnt = '0E0';
1331 my $subrs_cur = $rs->cursor;
1332 while (my @pks = $subrs_cur->next) {
1335 for my $i (0.. $#pcols) {
1336 $cond->{$pcols[$i]} = $pks[$i];
1341 $op eq 'update' ? $values : (),
1355 my $sql_maker = $self->sql_maker;
1356 local $sql_maker->{for};
1357 return $self->_execute($self->_select_args(@_));
1360 sub _select_args_to_query {
1363 my $sql_maker = $self->sql_maker;
1364 local $sql_maker->{for};
1366 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1367 # = $self->_select_args($ident, $select, $cond, $attrs);
1368 my ($op, $bind, $ident, $bind_attrs, @args) =
1369 $self->_select_args(@_);
1371 # my ($sql, $bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1372 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1374 return \[ "($sql)", @{ $prepared_bind || [] }];
1378 my ($self, $ident, $select, $condition, $attrs) = @_;
1380 my $for = delete $attrs->{for};
1381 my $sql_maker = $self->sql_maker;
1382 $sql_maker->{for} = $for;
1385 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1386 (qw/order_by group_by having _virtual_order_by/ )
1390 my $bind_attrs = {};
1392 my $alias2source = $self->_resolve_ident_sources ($ident);
1394 for my $alias (keys %$alias2source) {
1395 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1396 for my $col (keys %$bindtypes) {
1398 my $fqcn = join ('.', $alias, $col);
1399 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1401 # so that unqualified searches can be bound too
1402 $bind_attrs->{$col} = $bind_attrs->{$fqcn} if $alias eq 'me';
1406 # This would be the point to deflate anything found in $condition
1407 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1408 # expect a row object. And all we have is a resultsource (it is trivial
1409 # to extract deflator coderefs via $alias2source above).
1411 # I don't see a way forward other than changing the way deflators are
1412 # invoked, and that's just bad...
1414 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1415 if ($attrs->{software_limit} ||
1416 $sql_maker->_default_limit_syntax eq "GenericSubQ") {
1417 $attrs->{software_limit} = 1;
1419 $self->throw_exception("rows attribute must be positive if present")
1420 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1422 # MySQL actually recommends this approach. I cringe.
1423 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1424 push @args, $attrs->{rows}, $attrs->{offset};
1429 sub _resolve_ident_sources {
1430 my ($self, $ident) = @_;
1432 my $alias2source = {};
1434 # the reason this is so contrived is that $ident may be a {from}
1435 # structure, specifying multiple tables to join
1436 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1437 # this is compat mode for insert/update/delete which do not deal with aliases
1438 $alias2source->{me} = $ident;
1440 elsif (ref $ident eq 'ARRAY') {
1444 if (ref $_ eq 'HASH') {
1447 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1451 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-result_source}
1452 if ($tabinfo->{-result_source});
1456 return $alias2source;
1460 my ($self, $source, $attrs) = @_;
1462 my $tmp_attrs = { %$attrs };
1464 # take off any pagers, record_filter is cdbi, and no point of ordering a count
1465 delete $tmp_attrs->{$_} for (qw/select as rows offset page order_by record_filter/);
1467 # overwrite the selector
1468 $tmp_attrs->{select} = { count => '*' };
1470 my $tmp_rs = $source->resultset_class->new($source, $tmp_attrs);
1471 my ($count) = $tmp_rs->cursor->next;
1473 # if the offset/rows attributes are still present, we did not use
1474 # a subquery, so we need to make the calculations in software
1475 $count -= $attrs->{offset} if $attrs->{offset};
1476 $count = $attrs->{rows} if $attrs->{rows} and $attrs->{rows} < $count;
1477 $count = 0 if ($count < 0);
1483 my ($self, $source, $attrs) = @_;
1485 # copy for the subquery, we need to do some adjustments to it too
1486 my $sub_attrs = { %$attrs };
1488 # these can not go in the subquery, and there is no point of ordering it
1489 delete $sub_attrs->{$_} for qw/prefetch collapse select as order_by/;
1491 # if we prefetch, we group_by primary keys only as this is what we would get out of the rs via ->next/->all
1492 # simply deleting group_by suffices, as the code below will re-fill it
1493 # Note: we check $attrs, as $sub_attrs has collapse deleted
1494 if (ref $attrs->{collapse} and keys %{$attrs->{collapse}} ) {
1495 delete $sub_attrs->{group_by};
1498 $sub_attrs->{group_by} ||= [ map { "$attrs->{alias}.$_" } ($source->primary_columns) ];
1499 $sub_attrs->{select} = $self->_grouped_count_select ($source, $sub_attrs);
1502 count_subq => $source->resultset_class->new ($source, $sub_attrs )->as_query
1505 # the subquery replaces this
1506 delete $attrs->{$_} for qw/where bind prefetch collapse group_by having having_bind rows offset page pager/;
1508 return $self->count ($source, $attrs);
1512 # Returns a SELECT to go with a supplied GROUP BY
1513 # (caled by count_grouped so a group_by is present)
1514 # Most databases expect them to match, but some
1515 # choke in various ways.
1517 sub _grouped_count_select {
1518 my ($self, $source, $rs_args) = @_;
1519 return $rs_args->{group_by};
1522 sub source_bind_attributes {
1523 my ($self, $source) = @_;
1525 my $bind_attributes;
1526 foreach my $column ($source->columns) {
1528 my $data_type = $source->column_info($column)->{data_type} || '';
1529 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1533 return $bind_attributes;
1540 =item Arguments: $ident, $select, $condition, $attrs
1544 Handle a SQL select statement.
1550 my ($ident, $select, $condition, $attrs) = @_;
1551 return $self->cursor_class->new($self, \@_, $attrs);
1556 my ($rv, $sth, @bind) = $self->_select(@_);
1557 my @row = $sth->fetchrow_array;
1558 my @nextrow = $sth->fetchrow_array if @row;
1559 if(@row && @nextrow) {
1560 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1562 # Need to call finish() to work round broken DBDs
1571 =item Arguments: $sql
1575 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1580 my ($self, $dbh, $sql) = @_;
1582 # 3 is the if_active parameter which avoids active sth re-use
1583 my $sth = $self->disable_sth_caching
1584 ? $dbh->prepare($sql)
1585 : $dbh->prepare_cached($sql, {}, 3);
1587 # XXX You would think RaiseError would make this impossible,
1588 # but apparently that's not true :(
1589 $self->throw_exception($dbh->errstr) if !$sth;
1595 my ($self, $sql) = @_;
1596 $self->dbh_do('_dbh_sth', $sql);
1599 sub _dbh_columns_info_for {
1600 my ($self, $dbh, $table) = @_;
1602 if ($dbh->can('column_info')) {
1605 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1606 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1608 while ( my $info = $sth->fetchrow_hashref() ){
1610 $column_info{data_type} = $info->{TYPE_NAME};
1611 $column_info{size} = $info->{COLUMN_SIZE};
1612 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1613 $column_info{default_value} = $info->{COLUMN_DEF};
1614 my $col_name = $info->{COLUMN_NAME};
1615 $col_name =~ s/^\"(.*)\"$/$1/;
1617 $result{$col_name} = \%column_info;
1620 return \%result if !$@ && scalar keys %result;
1624 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1626 my @columns = @{$sth->{NAME_lc}};
1627 for my $i ( 0 .. $#columns ){
1629 $column_info{data_type} = $sth->{TYPE}->[$i];
1630 $column_info{size} = $sth->{PRECISION}->[$i];
1631 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1633 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1634 $column_info{data_type} = $1;
1635 $column_info{size} = $2;
1638 $result{$columns[$i]} = \%column_info;
1642 foreach my $col (keys %result) {
1643 my $colinfo = $result{$col};
1644 my $type_num = $colinfo->{data_type};
1646 if(defined $type_num && $dbh->can('type_info')) {
1647 my $type_info = $dbh->type_info($type_num);
1648 $type_name = $type_info->{TYPE_NAME} if $type_info;
1649 $colinfo->{data_type} = $type_name if $type_name;
1656 sub columns_info_for {
1657 my ($self, $table) = @_;
1658 $self->dbh_do('_dbh_columns_info_for', $table);
1661 =head2 last_insert_id
1663 Return the row id of the last insert.
1667 sub _dbh_last_insert_id {
1668 # All Storage's need to register their own _dbh_last_insert_id
1669 # the old SQLite-based method was highly inappropriate
1672 my $class = ref $self;
1673 $self->throw_exception (<<EOE);
1675 No _dbh_last_insert_id() method found in $class.
1676 Since the method of obtaining the autoincrement id of the last insert
1677 operation varies greatly between different databases, this method must be
1678 individually implemented for every storage class.
1682 sub last_insert_id {
1684 $self->dbh_do('_dbh_last_insert_id', @_);
1689 Returns the database driver name.
1693 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1695 =head2 bind_attribute_by_data_type
1697 Given a datatype from column info, returns a database specific bind
1698 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1699 let the database planner just handle it.
1701 Generally only needed for special case column types, like bytea in postgres.
1705 sub bind_attribute_by_data_type {
1709 =head2 is_datatype_numeric
1711 Given a datatype from column_info, returns a boolean value indicating if
1712 the current RDBMS considers it a numeric value. This controls how
1713 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1714 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1715 be performed instead of the usual C<eq>.
1719 sub is_datatype_numeric {
1720 my ($self, $dt) = @_;
1722 return 0 unless $dt;
1724 return $dt =~ /^ (?:
1725 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
1730 =head2 create_ddl_dir (EXPERIMENTAL)
1734 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1738 Creates a SQL file based on the Schema, for each of the specified
1739 database engines in C<\@databases> in the given directory.
1740 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1742 Given a previous version number, this will also create a file containing
1743 the ALTER TABLE statements to transform the previous schema into the
1744 current one. Note that these statements may contain C<DROP TABLE> or
1745 C<DROP COLUMN> statements that can potentially destroy data.
1747 The file names are created using the C<ddl_filename> method below, please
1748 override this method in your schema if you would like a different file
1749 name format. For the ALTER file, the same format is used, replacing
1750 $version in the name with "$preversion-$version".
1752 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1753 The most common value for this would be C<< { add_drop_table => 1 } >>
1754 to have the SQL produced include a C<DROP TABLE> statement for each table
1755 created. For quoting purposes supply C<quote_table_names> and
1756 C<quote_field_names>.
1758 If no arguments are passed, then the following default values are assumed:
1762 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1764 =item version - $schema->schema_version
1766 =item directory - './'
1768 =item preversion - <none>
1772 By default, C<\%sqlt_args> will have
1774 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1776 merged with the hash passed in. To disable any of those features, pass in a
1777 hashref like the following
1779 { ignore_constraint_names => 0, # ... other options }
1782 Note that this feature is currently EXPERIMENTAL and may not work correctly
1783 across all databases, or fully handle complex relationships.
1785 WARNING: Please check all SQL files created, before applying them.
1789 sub create_ddl_dir {
1790 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1792 if(!$dir || !-d $dir) {
1793 carp "No directory given, using ./\n";
1796 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1797 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1799 my $schema_version = $schema->schema_version || '1.x';
1800 $version ||= $schema_version;
1803 add_drop_table => 1,
1804 ignore_constraint_names => 1,
1805 ignore_index_names => 1,
1809 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
1810 . $self->_check_sqlt_message . q{'})
1811 if !$self->_check_sqlt_version;
1813 my $sqlt = SQL::Translator->new( $sqltargs );
1815 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1816 my $sqlt_schema = $sqlt->translate({ data => $schema })
1817 or $self->throw_exception ($sqlt->error);
1819 foreach my $db (@$databases) {
1821 $sqlt->{schema} = $sqlt_schema;
1822 $sqlt->producer($db);
1825 my $filename = $schema->ddl_filename($db, $version, $dir);
1826 if (-e $filename && ($version eq $schema_version )) {
1827 # if we are dumping the current version, overwrite the DDL
1828 carp "Overwriting existing DDL file - $filename";
1832 my $output = $sqlt->translate;
1834 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1837 if(!open($file, ">$filename")) {
1838 $self->throw_exception("Can't open $filename for writing ($!)");
1841 print $file $output;
1844 next unless ($preversion);
1846 require SQL::Translator::Diff;
1848 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1849 if(!-e $prefilename) {
1850 carp("No previous schema file found ($prefilename)");
1854 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1856 carp("Overwriting existing diff file - $difffile");
1862 my $t = SQL::Translator->new($sqltargs);
1867 or $self->throw_exception ($t->error);
1869 my $out = $t->translate( $prefilename )
1870 or $self->throw_exception ($t->error);
1872 $source_schema = $t->schema;
1874 $source_schema->name( $prefilename )
1875 unless ( $source_schema->name );
1878 # The "new" style of producers have sane normalization and can support
1879 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
1880 # And we have to diff parsed SQL against parsed SQL.
1881 my $dest_schema = $sqlt_schema;
1883 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
1884 my $t = SQL::Translator->new($sqltargs);
1889 or $self->throw_exception ($t->error);
1891 my $out = $t->translate( $filename )
1892 or $self->throw_exception ($t->error);
1894 $dest_schema = $t->schema;
1896 $dest_schema->name( $filename )
1897 unless $dest_schema->name;
1900 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1904 if(!open $file, ">$difffile") {
1905 $self->throw_exception("Can't write to $difffile ($!)");
1913 =head2 deployment_statements
1917 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1921 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1923 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
1924 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
1926 C<$directory> is used to return statements from files in a previously created
1927 L</create_ddl_dir> directory and is optional. The filenames are constructed
1928 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1930 If no C<$directory> is specified then the statements are constructed on the
1931 fly using L<SQL::Translator> and C<$version> is ignored.
1933 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1937 sub deployment_statements {
1938 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1939 # Need to be connected to get the correct sqlt_type
1940 $self->ensure_connected() unless $type;
1941 $type ||= $self->sqlt_type;
1942 $version ||= $schema->schema_version || '1.x';
1944 my $filename = $schema->ddl_filename($type, $version, $dir);
1948 open($file, "<$filename")
1949 or $self->throw_exception("Can't open $filename ($!)");
1952 return join('', @rows);
1955 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
1956 . $self->_check_sqlt_message . q{'})
1957 if !$self->_check_sqlt_version;
1959 require SQL::Translator::Parser::DBIx::Class;
1960 eval qq{use SQL::Translator::Producer::${type}};
1961 $self->throw_exception($@) if $@;
1963 # sources needs to be a parser arg, but for simplicty allow at top level
1965 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1966 if exists $sqltargs->{sources};
1968 my $tr = SQL::Translator->new(%$sqltargs);
1969 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1970 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1974 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1977 return if($line =~ /^--/);
1979 # next if($line =~ /^DROP/m);
1980 return if($line =~ /^BEGIN TRANSACTION/m);
1981 return if($line =~ /^COMMIT/m);
1982 return if $line =~ /^\s+$/; # skip whitespace only
1983 $self->_query_start($line);
1985 $self->dbh->do($line); # shouldn't be using ->dbh ?
1988 carp qq{$@ (running "${line}")};
1990 $self->_query_end($line);
1992 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
1993 if (@statements > 1) {
1994 foreach my $statement (@statements) {
1995 $deploy->( $statement );
1998 elsif (@statements == 1) {
1999 foreach my $line ( split(";\n", $statements[0])) {
2005 =head2 datetime_parser
2007 Returns the datetime parser class
2011 sub datetime_parser {
2013 return $self->{datetime_parser} ||= do {
2014 $self->ensure_connected;
2015 $self->build_datetime_parser(@_);
2019 =head2 datetime_parser_type
2021 Defines (returns) the datetime parser class - currently hardwired to
2022 L<DateTime::Format::MySQL>
2026 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2028 =head2 build_datetime_parser
2030 See L</datetime_parser>
2034 sub build_datetime_parser {
2036 my $type = $self->datetime_parser_type(@_);
2038 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2043 my $_check_sqlt_version; # private
2044 my $_check_sqlt_message; # private
2045 sub _check_sqlt_version {
2046 return $_check_sqlt_version if defined $_check_sqlt_version;
2047 eval 'use SQL::Translator "0.09003"';
2048 $_check_sqlt_message = $@ || '';
2049 $_check_sqlt_version = !$@;
2052 sub _check_sqlt_message {
2053 _check_sqlt_version if !defined $_check_sqlt_message;
2054 $_check_sqlt_message;
2058 =head2 is_replicating
2060 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2061 replicate from a master database. Default is undef, which is the result
2062 returned by databases that don't support replication.
2066 sub is_replicating {
2071 =head2 lag_behind_master
2073 Returns a number that represents a certain amount of lag behind a master db
2074 when a given storage is replicating. The number is database dependent, but
2075 starts at zero and increases with the amount of lag. Default in undef
2079 sub lag_behind_master {
2085 return if !$self->_dbh;
2094 =head2 DBIx::Class and AutoCommit
2096 DBIx::Class can do some wonderful magic with handling exceptions,
2097 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2098 combined with C<txn_do> for transaction support.
2100 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2101 in an assumed transaction between commits, and you're telling us you'd
2102 like to manage that manually. A lot of the magic protections offered by
2103 this module will go away. We can't protect you from exceptions due to database
2104 disconnects because we don't know anything about how to restart your
2105 transactions. You're on your own for handling all sorts of exceptional
2106 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2113 Matt S. Trout <mst@shadowcatsystems.co.uk>
2115 Andy Grundman <andy@hybridized.org>
2119 You may distribute this code under the same terms as Perl itself.