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 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.
224 =item set_datetime_format
226 Execute any statements necessary to initialize the database session to return
227 and accept datetime/timestamp values used with
228 L<DBIx::Class::InflateColumn::DateTime>.
232 =item on_disconnect_call
234 Takes arguments in the same form as L</on_connect_call> and executes them
235 immediately before disconnecting from the database.
237 Calls the C<disconnect_call_METHOD> methods as opposed to the
238 C<connect_call_METHOD> methods called by L</on_connect_call>.
240 Note, this only runs if you explicitly call L</disconnect> on the
243 =item disable_sth_caching
245 If set to a true value, this option will disable the caching of
246 statement handles via L<DBI/prepare_cached>.
250 Sets the limit dialect. This is useful for JDBC-bridge among others
251 where the remote SQL-dialect cannot be determined by the name of the
252 driver alone. See also L<SQL::Abstract::Limit>.
256 Specifies what characters to use to quote table and column names. If
257 you use this you will want to specify L</name_sep> as well.
259 C<quote_char> expects either a single character, in which case is it
260 is placed on either side of the table/column name, or an arrayref of length
261 2 in which case the table/column name is placed between the elements.
263 For example under MySQL you should use C<< quote_char => '`' >>, and for
264 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
268 This only needs to be used in conjunction with C<quote_char>, and is used to
269 specify the charecter that seperates elements (schemas, tables, columns) from
270 each other. In most cases this is simply a C<.>.
272 The consequences of not supplying this value is that L<SQL::Abstract>
273 will assume DBIx::Class' uses of aliases to be complete column
274 names. The output will look like I<"me.name"> when it should actually
279 This Storage driver normally installs its own C<HandleError>, sets
280 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
281 all database handles, including those supplied by a coderef. It does this
282 so that it can have consistent and useful error behavior.
284 If you set this option to a true value, Storage will not do its usual
285 modifications to the database handle's attributes, and instead relies on
286 the settings in your connect_info DBI options (or the values you set in
287 your connection coderef, in the case that you are connecting via coderef).
289 Note that your custom settings can cause Storage to malfunction,
290 especially if you set a C<HandleError> handler that suppresses exceptions
291 and/or disable C<RaiseError>.
295 If this option is true, L<DBIx::Class> will use savepoints when nesting
296 transactions, making it possible to recover from failure in the inner
297 transaction without having to abort all outer transactions.
301 Use this argument to supply a cursor class other than the default
302 L<DBIx::Class::Storage::DBI::Cursor>.
306 Some real-life examples of arguments to L</connect_info> and
307 L<DBIx::Class::Schema/connect>
309 # Simple SQLite connection
310 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
313 ->connect_info([ sub { DBI->connect(...) } ]);
315 # A bit more complicated
322 { quote_char => q{"}, name_sep => q{.} },
326 # Equivalent to the previous example
332 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
336 # Same, but with hashref as argument
337 # See parse_connect_info for explanation
340 dsn => 'dbi:Pg:dbname=foo',
342 password => 'my_pg_password',
349 # Subref + DBIx::Class-specific connection options
352 sub { DBI->connect(...) },
356 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
357 disable_sth_caching => 1,
367 my ($self, $info_arg) = @_;
369 return $self->_connect_info if !$info_arg;
371 my @args = @$info_arg; # take a shallow copy for further mutilation
372 $self->_connect_info([@args]); # copy for _connect_info
375 # combine/pre-parse arguments depending on invocation style
378 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
379 %attrs = %{ $args[1] || {} };
382 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
383 %attrs = %{$args[0]};
385 for (qw/password user dsn/) {
386 unshift @args, delete $attrs{$_};
389 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
391 % { $args[3] || {} },
392 % { $args[4] || {} },
394 @args = @args[0,1,2];
397 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
398 # the new set of options
399 $self->_sql_maker(undef);
400 $self->_sql_maker_opts({});
403 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
404 if(my $value = delete $attrs{$storage_opt}) {
405 $self->$storage_opt($value);
408 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
409 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
410 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
413 for my $connect_do_opt (qw/on_connect_do on_disconnect_do/) {
414 if(my $opt_val = delete $attrs{$connect_do_opt}) {
415 $self->$connect_do_opt($opt_val);
420 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
422 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
423 $self->_connect_info;
428 This method is deprecated in favour of setting via L</connect_info>.
434 $self->_setup_connect_do(on_connect_do => @_);
437 =head2 on_disconnect_do
439 This method is deprecated in favour of setting via L</connect_info>.
443 sub on_disconnect_do {
445 $self->_setup_connect_do(on_disconnect_do => @_);
448 sub _setup_connect_do {
449 my ($self, $opt) = (shift, shift);
451 my $accessor = "_$opt";
453 return $self->$accessor if not @_;
457 (my $call = $opt) =~ s/_do\z/_call/;
459 if (ref($self->$call) ne 'ARRAY') {
461 defined $self->$call ? $self->$call : ()
466 push @{ $self->$call }, [ 'do_sql', $val ];
467 } elsif (ref($val) eq 'CODE') {
468 push @{ $self->$call }, $val;
469 } elsif (ref($val) eq 'ARRAY') {
470 push @{ $self->$call },
471 map [ 'do_sql', $_ ], @$val;
473 $self->throw_exception("Invalid type for $opt ".ref($val));
476 $self->$accessor($val);
481 Arguments: ($subref | $method_name), @extra_coderef_args?
483 Execute the given $subref or $method_name using the new exception-based
484 connection management.
486 The first two arguments will be the storage object that C<dbh_do> was called
487 on and a database handle to use. Any additional arguments will be passed
488 verbatim to the called subref as arguments 2 and onwards.
490 Using this (instead of $self->_dbh or $self->dbh) ensures correct
491 exception handling and reconnection (or failover in future subclasses).
493 Your subref should have no side-effects outside of the database, as
494 there is the potential for your subref to be partially double-executed
495 if the database connection was stale/dysfunctional.
499 my @stuff = $schema->storage->dbh_do(
501 my ($storage, $dbh, @cols) = @_;
502 my $cols = join(q{, }, @cols);
503 $dbh->selectrow_array("SELECT $cols FROM foo");
514 my $dbh = $self->_dbh;
516 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
517 || $self->{transaction_depth};
519 local $self->{_in_dbh_do} = 1;
522 my $want_array = wantarray;
525 $self->_verify_pid if $dbh;
527 $self->_populate_dbh;
532 @result = $self->$code($dbh, @_);
534 elsif(defined $want_array) {
535 $result[0] = $self->$code($dbh, @_);
538 $self->$code($dbh, @_);
543 if(!$exception) { return $want_array ? @result : $result[0] }
545 $self->throw_exception($exception) if $self->connected;
547 # We were not connected - reconnect and retry, but let any
548 # exception fall right through this time
549 $self->_populate_dbh;
550 $self->$code($self->_dbh, @_);
553 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
554 # It also informs dbh_do to bypass itself while under the direction of txn_do,
555 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
560 ref $coderef eq 'CODE' or $self->throw_exception
561 ('$coderef must be a CODE reference');
563 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
565 local $self->{_in_dbh_do} = 1;
568 my $want_array = wantarray;
573 $self->_verify_pid if $self->_dbh;
574 $self->_populate_dbh if !$self->_dbh;
578 @result = $coderef->(@_);
580 elsif(defined $want_array) {
581 $result[0] = $coderef->(@_);
590 if(!$exception) { return $want_array ? @result : $result[0] }
592 if($tried++ > 0 || $self->connected) {
593 eval { $self->txn_rollback };
594 my $rollback_exception = $@;
595 if($rollback_exception) {
596 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
597 $self->throw_exception($exception) # propagate nested rollback
598 if $rollback_exception =~ /$exception_class/;
600 $self->throw_exception(
601 "Transaction aborted: ${exception}. "
602 . "Rollback failed: ${rollback_exception}"
605 $self->throw_exception($exception)
608 # We were not connected, and was first try - reconnect and retry
610 $self->_populate_dbh;
616 Our C<disconnect> method also performs a rollback first if the
617 database is not in C<AutoCommit> mode.
624 if( $self->connected ) {
625 my $connection_call = $self->on_disconnect_call;
626 $self->_do_connection_actions(disconnect_call_ => $connection_call)
629 $self->_dbh->rollback unless $self->_dbh_autocommit;
630 $self->_dbh->disconnect;
636 =head2 with_deferred_fk_checks
640 =item Arguments: C<$coderef>
642 =item Return Value: The return value of $coderef
646 Storage specific method to run the code ref with FK checks deferred or
647 in MySQL's case disabled entirely.
651 # Storage subclasses should override this
652 sub with_deferred_fk_checks {
653 my ($self, $sub) = @_;
661 if(my $dbh = $self->_dbh) {
662 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
669 return 0 if !$self->_dbh;
671 return ($dbh->FETCH('Active') && $dbh->ping);
677 # handle pid changes correctly
678 # NOTE: assumes $self->_dbh is a valid $dbh
682 return if defined $self->_conn_pid && $self->_conn_pid == $$;
684 $self->_dbh->{InactiveDestroy} = 1;
691 sub ensure_connected {
694 unless ($self->connected) {
695 $self->_populate_dbh;
701 Returns the dbh - a data base handle of class L<DBI>.
708 $self->ensure_connected;
712 sub _sql_maker_args {
715 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
720 unless ($self->_sql_maker) {
721 my $sql_maker_class = $self->sql_maker_class;
722 $self->ensure_class_loaded ($sql_maker_class);
723 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
725 return $self->_sql_maker;
732 my @info = @{$self->_dbi_connect_info || []};
733 $self->_dbh($self->_connect(@info));
735 $self->_conn_pid($$);
736 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
738 $self->_determine_driver;
740 # Always set the transaction depth on connect, since
741 # there is no transaction in progress by definition
742 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
744 my $connection_call = $self->on_connect_call;
745 $self->_do_connection_actions(connect_call_ => $connection_call)
749 sub _determine_driver {
752 if (ref $self eq 'DBIx::Class::Storage::DBI') {
755 if ($self->_dbh) { # we are connected
756 $driver = $self->_dbh->{Driver}{Name};
758 # try to use dsn to not require being connected, the driver may still
759 # force a connection in _rebless to determine version
760 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
763 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
764 bless $self, "DBIx::Class::Storage::DBI::${driver}";
770 sub _do_connection_actions {
772 my $method_prefix = shift;
775 if (not ref($call)) {
776 my $method = $method_prefix . $call;
778 } elsif (ref($call) eq 'CODE') {
780 } elsif (ref($call) eq 'ARRAY') {
781 if (ref($call->[0]) ne 'ARRAY') {
782 $self->_do_connection_actions($method_prefix, $_) for @$call;
784 $self->_do_connection_actions($method_prefix, @$_) for @$call;
787 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
793 sub connect_call_do_sql {
795 $self->_do_query(@_);
798 sub disconnect_call_do_sql {
800 $self->_do_query(@_);
803 # override in db-specific backend when necessary
804 sub connect_call_set_datetime_format { 1 }
807 my ($self, $action) = @_;
809 if (ref $action eq 'CODE') {
810 $action = $action->($self);
811 $self->_do_query($_) foreach @$action;
814 # Most debuggers expect ($sql, @bind), so we need to exclude
815 # the attribute hash which is the second argument to $dbh->do
816 # furthermore the bind values are usually to be presented
817 # as named arrayref pairs, so wrap those here too
818 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
819 my $sql = shift @do_args;
820 my $attrs = shift @do_args;
821 my @bind = map { [ undef, $_ ] } @do_args;
823 $self->_query_start($sql, @bind);
824 $self->_dbh->do($sql, $attrs, @do_args);
825 $self->_query_end($sql, @bind);
832 my ($self, @info) = @_;
834 $self->throw_exception("You failed to provide any connection info")
837 my ($old_connect_via, $dbh);
839 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
840 $old_connect_via = $DBI::connect_via;
841 $DBI::connect_via = 'connect';
845 if(ref $info[0] eq 'CODE') {
849 $dbh = DBI->connect(@info);
852 if($dbh && !$self->unsafe) {
853 my $weak_self = $self;
854 Scalar::Util::weaken($weak_self);
855 $dbh->{HandleError} = sub {
857 $weak_self->throw_exception("DBI Exception: $_[0]");
860 croak ("DBI Exception: $_[0]");
863 $dbh->{ShowErrorStatement} = 1;
864 $dbh->{RaiseError} = 1;
865 $dbh->{PrintError} = 0;
869 $DBI::connect_via = $old_connect_via if $old_connect_via;
871 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
874 $self->_dbh_autocommit($dbh->{AutoCommit});
880 my ($self, $name) = @_;
882 $name = $self->_svp_generate_name
883 unless defined $name;
885 $self->throw_exception ("You can't use savepoints outside a transaction")
886 if $self->{transaction_depth} == 0;
888 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
889 unless $self->can('_svp_begin');
891 push @{ $self->{savepoints} }, $name;
893 $self->debugobj->svp_begin($name) if $self->debug;
895 return $self->_svp_begin($name);
899 my ($self, $name) = @_;
901 $self->throw_exception ("You can't use savepoints outside a transaction")
902 if $self->{transaction_depth} == 0;
904 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
905 unless $self->can('_svp_release');
908 $self->throw_exception ("Savepoint '$name' does not exist")
909 unless grep { $_ eq $name } @{ $self->{savepoints} };
911 # Dig through the stack until we find the one we are releasing. This keeps
912 # the stack up to date.
915 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
917 $name = pop @{ $self->{savepoints} };
920 $self->debugobj->svp_release($name) if $self->debug;
922 return $self->_svp_release($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_rollback');
935 # If they passed us a name, verify that it exists in the stack
936 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
937 $self->throw_exception("Savepoint '$name' does not exist!");
940 # Dig through the stack until we find the one we are releasing. This keeps
941 # the stack up to date.
942 while(my $s = pop(@{ $self->{savepoints} })) {
943 last if($s eq $name);
945 # Add the savepoint back to the stack, as a rollback doesn't remove the
946 # named savepoint, only everything after it.
947 push(@{ $self->{savepoints} }, $name);
949 # We'll assume they want to rollback to the last savepoint
950 $name = $self->{savepoints}->[-1];
953 $self->debugobj->svp_rollback($name) if $self->debug;
955 return $self->_svp_rollback($name);
958 sub _svp_generate_name {
961 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
966 $self->ensure_connected();
967 if($self->{transaction_depth} == 0) {
968 $self->debugobj->txn_begin()
970 # this isn't ->_dbh-> because
971 # we should reconnect on begin_work
972 # for AutoCommit users
973 $self->dbh->begin_work;
974 } elsif ($self->auto_savepoint) {
977 $self->{transaction_depth}++;
982 if ($self->{transaction_depth} == 1) {
983 my $dbh = $self->_dbh;
984 $self->debugobj->txn_commit()
987 $self->{transaction_depth} = 0
988 if $self->_dbh_autocommit;
990 elsif($self->{transaction_depth} > 1) {
991 $self->{transaction_depth}--;
993 if $self->auto_savepoint;
999 my $dbh = $self->_dbh;
1001 if ($self->{transaction_depth} == 1) {
1002 $self->debugobj->txn_rollback()
1004 $self->{transaction_depth} = 0
1005 if $self->_dbh_autocommit;
1008 elsif($self->{transaction_depth} > 1) {
1009 $self->{transaction_depth}--;
1010 if ($self->auto_savepoint) {
1011 $self->svp_rollback;
1016 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1021 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1022 $error =~ /$exception_class/ and $self->throw_exception($error);
1023 # ensure that a failed rollback resets the transaction depth
1024 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1025 $self->throw_exception($error);
1029 # This used to be the top-half of _execute. It was split out to make it
1030 # easier to override in NoBindVars without duping the rest. It takes up
1031 # all of _execute's args, and emits $sql, @bind.
1032 sub _prep_for_execute {
1033 my ($self, $op, $extra_bind, $ident, $args) = @_;
1035 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1036 $ident = $ident->from();
1039 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1042 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1044 return ($sql, \@bind);
1051 =item Arguments: $rs_attrs
1053 =item Return Value: \[ $sql, @bind ]
1057 Returns the SQL statement and bind vars that would result from the given
1058 ResultSet attributes (does not actually run a query)
1063 my ($self, $rs_attr) = @_;
1065 my $sql_maker = $self->sql_maker;
1066 local $sql_maker->{for};
1068 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset) = $self->_select_args(...);
1069 my @args = $self->_select_args($rs_attr->{from}, $rs_attr->{select}, $rs_attr->{where}, $rs_attr);
1071 # my ($sql, $bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1072 my ($sql, $bind) = $self->_prep_for_execute(
1074 [ @args[4 .. $#args] ],
1076 return \[ "($sql)", @{ $bind || [] }];
1079 sub _fix_bind_params {
1080 my ($self, @bind) = @_;
1082 ### Turn @bind from something like this:
1083 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1085 ### ( "'1'", "'1'", "'3'" )
1088 if ( defined( $_ && $_->[1] ) ) {
1089 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1096 my ( $self, $sql, @bind ) = @_;
1098 if ( $self->debug ) {
1099 @bind = $self->_fix_bind_params(@bind);
1101 $self->debugobj->query_start( $sql, @bind );
1106 my ( $self, $sql, @bind ) = @_;
1108 if ( $self->debug ) {
1109 @bind = $self->_fix_bind_params(@bind);
1110 $self->debugobj->query_end( $sql, @bind );
1115 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1117 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1119 $self->_query_start( $sql, @$bind );
1121 my $sth = $self->sth($sql,$op);
1123 my $placeholder_index = 1;
1125 foreach my $bound (@$bind) {
1126 my $attributes = {};
1127 my($column_name, @data) = @$bound;
1129 if ($bind_attributes) {
1130 $attributes = $bind_attributes->{$column_name}
1131 if defined $bind_attributes->{$column_name};
1134 foreach my $data (@data) {
1135 my $ref = ref $data;
1136 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1138 $sth->bind_param($placeholder_index, $data, $attributes);
1139 $placeholder_index++;
1143 # Can this fail without throwing an exception anyways???
1144 my $rv = $sth->execute();
1145 $self->throw_exception($sth->errstr) if !$rv;
1147 $self->_query_end( $sql, @$bind );
1149 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1154 $self->dbh_do('_dbh_execute', @_)
1158 my ($self, $source, $to_insert) = @_;
1160 my $ident = $source->from;
1161 my $bind_attributes = $self->source_bind_attributes($source);
1163 my $updated_cols = {};
1165 $self->ensure_connected;
1166 foreach my $col ( $source->columns ) {
1167 if ( !defined $to_insert->{$col} ) {
1168 my $col_info = $source->column_info($col);
1170 if ( $col_info->{auto_nextval} ) {
1171 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1176 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1178 return $updated_cols;
1181 ## Still not quite perfect, and EXPERIMENTAL
1182 ## Currently it is assumed that all values passed will be "normal", i.e. not
1183 ## scalar refs, or at least, all the same type as the first set, the statement is
1184 ## only prepped once.
1186 my ($self, $source, $cols, $data) = @_;
1188 my $table = $source->from;
1189 @colvalues{@$cols} = (0..$#$cols);
1190 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1192 $self->_query_start( $sql, @bind );
1193 my $sth = $self->sth($sql);
1195 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1197 ## This must be an arrayref, else nothing works!
1198 my $tuple_status = [];
1200 ## Get the bind_attributes, if any exist
1201 my $bind_attributes = $self->source_bind_attributes($source);
1203 ## Bind the values and execute
1204 my $placeholder_index = 1;
1206 foreach my $bound (@bind) {
1208 my $attributes = {};
1209 my ($column_name, $data_index) = @$bound;
1211 if( $bind_attributes ) {
1212 $attributes = $bind_attributes->{$column_name}
1213 if defined $bind_attributes->{$column_name};
1216 my @data = map { $_->[$data_index] } @$data;
1218 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1219 $placeholder_index++;
1221 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1224 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1226 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1227 if ($i > $#$tuple_status);
1229 require Data::Dumper;
1230 local $Data::Dumper::Terse = 1;
1231 local $Data::Dumper::Indent = 1;
1232 local $Data::Dumper::Useqq = 1;
1233 local $Data::Dumper::Quotekeys = 0;
1235 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1236 $tuple_status->[$i][1],
1237 Data::Dumper::Dumper(
1238 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1242 $self->throw_exception($sth->errstr) if !$rv;
1244 $self->_query_end( $sql, @bind );
1245 return (wantarray ? ($rv, $sth, @bind) : $rv);
1249 my $self = shift @_;
1250 my $source = shift @_;
1251 my $bind_attributes = $self->source_bind_attributes($source);
1253 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1258 my $self = shift @_;
1259 my $source = shift @_;
1261 my $bind_attrs = $self->source_bind_attributes($source);
1263 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1266 # We were sent here because the $rs contains a complex search
1267 # which will require a subquery to select the correct rows
1268 # (i.e. joined or limited resultsets)
1270 # Genarating a single PK column subquery is trivial and supported
1271 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1272 # Look at _multipk_update_delete()
1273 sub _subq_update_delete {
1275 my ($rs, $op, $values) = @_;
1277 my $rsrc = $rs->result_source;
1279 # we already check this, but double check naively just in case. Should be removed soon
1280 my $sel = $rs->_resolved_attrs->{select};
1281 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1282 my @pcols = $rsrc->primary_columns;
1283 if (@$sel != @pcols) {
1284 $self->throw_exception (
1285 'Subquery update/delete can not be called on resultsets selecting a'
1286 .' number of columns different than the number of primary keys'
1293 $op eq 'update' ? $values : (),
1294 { $pcols[0] => { -in => $rs->as_query } },
1299 return $self->_multipk_update_delete (@_);
1303 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1304 # resultset update/delete involving subqueries. So by default resort
1305 # to simple (and inefficient) delete_all style per-row opearations,
1306 # while allowing specific storages to override this with a faster
1309 sub _multipk_update_delete {
1310 return shift->_per_row_update_delete (@_);
1313 # This is the default loop used to delete/update rows for multi PK
1314 # resultsets, and used by mysql exclusively (because it can't do anything
1317 # We do not use $row->$op style queries, because resultset update/delete
1318 # is not expected to cascade (this is what delete_all/update_all is for).
1320 # There should be no race conditions as the entire operation is rolled
1323 sub _per_row_update_delete {
1325 my ($rs, $op, $values) = @_;
1327 my $rsrc = $rs->result_source;
1328 my @pcols = $rsrc->primary_columns;
1330 my $guard = $self->txn_scope_guard;
1332 # emulate the return value of $sth->execute for non-selects
1333 my $row_cnt = '0E0';
1335 my $subrs_cur = $rs->cursor;
1336 while (my @pks = $subrs_cur->next) {
1339 for my $i (0.. $#pcols) {
1340 $cond->{$pcols[$i]} = $pks[$i];
1345 $op eq 'update' ? $values : (),
1359 my $sql_maker = $self->sql_maker;
1360 local $sql_maker->{for};
1361 return $self->_execute($self->_select_args(@_));
1365 my ($self, $ident, $select, $condition, $attrs) = @_;
1367 my $for = delete $attrs->{for};
1368 my $sql_maker = $self->sql_maker;
1369 $sql_maker->{for} = $for;
1372 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1373 (qw/order_by group_by having _virtual_order_by/ )
1377 my $bind_attrs = {};
1379 my $alias2source = $self->_resolve_ident_sources ($ident);
1381 for my $alias (keys %$alias2source) {
1382 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1383 for my $col (keys %$bindtypes) {
1385 my $fqcn = join ('.', $alias, $col);
1386 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1388 # so that unqualified searches can be bound too
1389 $bind_attrs->{$col} = $bind_attrs->{$fqcn} if $alias eq 'me';
1393 # This would be the point to deflate anything found in $condition
1394 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1395 # expect a row object. And all we have is a resultsource (it is trivial
1396 # to extract deflator coderefs via $alias2source above).
1398 # I don't see a way forward other than changing the way deflators are
1399 # invoked, and that's just bad...
1401 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1402 if ($attrs->{software_limit} ||
1403 $sql_maker->_default_limit_syntax eq "GenericSubQ") {
1404 $attrs->{software_limit} = 1;
1406 $self->throw_exception("rows attribute must be positive if present")
1407 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1409 # MySQL actually recommends this approach. I cringe.
1410 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1411 push @args, $attrs->{rows}, $attrs->{offset};
1416 sub _resolve_ident_sources {
1417 my ($self, $ident) = @_;
1419 my $alias2source = {};
1421 # the reason this is so contrived is that $ident may be a {from}
1422 # structure, specifying multiple tables to join
1423 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1424 # this is compat mode for insert/update/delete which do not deal with aliases
1425 $alias2source->{me} = $ident;
1427 elsif (ref $ident eq 'ARRAY') {
1431 if (ref $_ eq 'HASH') {
1434 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1438 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-result_source}
1439 if ($tabinfo->{-result_source});
1443 return $alias2source;
1447 my ($self, $source, $attrs) = @_;
1449 my $tmp_attrs = { %$attrs };
1451 # take off any pagers, record_filter is cdbi, and no point of ordering a count
1452 delete $tmp_attrs->{$_} for (qw/select as rows offset page order_by record_filter/);
1454 # overwrite the selector
1455 $tmp_attrs->{select} = { count => '*' };
1457 my $tmp_rs = $source->resultset_class->new($source, $tmp_attrs);
1458 my ($count) = $tmp_rs->cursor->next;
1460 # if the offset/rows attributes are still present, we did not use
1461 # a subquery, so we need to make the calculations in software
1462 $count -= $attrs->{offset} if $attrs->{offset};
1463 $count = $attrs->{rows} if $attrs->{rows} and $attrs->{rows} < $count;
1464 $count = 0 if ($count < 0);
1470 my ($self, $source, $attrs) = @_;
1472 # copy for the subquery, we need to do some adjustments to it too
1473 my $sub_attrs = { %$attrs };
1475 # these can not go in the subquery, and there is no point of ordering it
1476 delete $sub_attrs->{$_} for qw/prefetch collapse select as order_by/;
1478 # if we prefetch, we group_by primary keys only as this is what we would get out of the rs via ->next/->all
1479 # simply deleting group_by suffices, as the code below will re-fill it
1480 # Note: we check $attrs, as $sub_attrs has collapse deleted
1481 if (ref $attrs->{collapse} and keys %{$attrs->{collapse}} ) {
1482 delete $sub_attrs->{group_by};
1485 $sub_attrs->{group_by} ||= [ map { "$attrs->{alias}.$_" } ($source->primary_columns) ];
1486 $sub_attrs->{select} = $self->_grouped_count_select ($source, $sub_attrs);
1489 count_subq => $source->resultset_class->new ($source, $sub_attrs )->as_query
1492 # the subquery replaces this
1493 delete $attrs->{$_} for qw/where bind prefetch collapse group_by having having_bind rows offset page pager/;
1495 return $self->count ($source, $attrs);
1499 # Returns a SELECT to go with a supplied GROUP BY
1500 # (caled by count_grouped so a group_by is present)
1501 # Most databases expect them to match, but some
1502 # choke in various ways.
1504 sub _grouped_count_select {
1505 my ($self, $source, $rs_args) = @_;
1506 return $rs_args->{group_by};
1509 sub source_bind_attributes {
1510 my ($self, $source) = @_;
1512 my $bind_attributes;
1513 foreach my $column ($source->columns) {
1515 my $data_type = $source->column_info($column)->{data_type} || '';
1516 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1520 return $bind_attributes;
1527 =item Arguments: $ident, $select, $condition, $attrs
1531 Handle a SQL select statement.
1537 my ($ident, $select, $condition, $attrs) = @_;
1538 return $self->cursor_class->new($self, \@_, $attrs);
1543 my ($rv, $sth, @bind) = $self->_select(@_);
1544 my @row = $sth->fetchrow_array;
1545 my @nextrow = $sth->fetchrow_array if @row;
1546 if(@row && @nextrow) {
1547 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1549 # Need to call finish() to work round broken DBDs
1558 =item Arguments: $sql
1562 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1567 my ($self, $dbh, $sql) = @_;
1569 # 3 is the if_active parameter which avoids active sth re-use
1570 my $sth = $self->disable_sth_caching
1571 ? $dbh->prepare($sql)
1572 : $dbh->prepare_cached($sql, {}, 3);
1574 # XXX You would think RaiseError would make this impossible,
1575 # but apparently that's not true :(
1576 $self->throw_exception($dbh->errstr) if !$sth;
1582 my ($self, $sql) = @_;
1583 $self->dbh_do('_dbh_sth', $sql);
1586 sub _dbh_columns_info_for {
1587 my ($self, $dbh, $table) = @_;
1589 if ($dbh->can('column_info')) {
1592 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1593 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1595 while ( my $info = $sth->fetchrow_hashref() ){
1597 $column_info{data_type} = $info->{TYPE_NAME};
1598 $column_info{size} = $info->{COLUMN_SIZE};
1599 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1600 $column_info{default_value} = $info->{COLUMN_DEF};
1601 my $col_name = $info->{COLUMN_NAME};
1602 $col_name =~ s/^\"(.*)\"$/$1/;
1604 $result{$col_name} = \%column_info;
1607 return \%result if !$@ && scalar keys %result;
1611 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1613 my @columns = @{$sth->{NAME_lc}};
1614 for my $i ( 0 .. $#columns ){
1616 $column_info{data_type} = $sth->{TYPE}->[$i];
1617 $column_info{size} = $sth->{PRECISION}->[$i];
1618 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1620 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1621 $column_info{data_type} = $1;
1622 $column_info{size} = $2;
1625 $result{$columns[$i]} = \%column_info;
1629 foreach my $col (keys %result) {
1630 my $colinfo = $result{$col};
1631 my $type_num = $colinfo->{data_type};
1633 if(defined $type_num && $dbh->can('type_info')) {
1634 my $type_info = $dbh->type_info($type_num);
1635 $type_name = $type_info->{TYPE_NAME} if $type_info;
1636 $colinfo->{data_type} = $type_name if $type_name;
1643 sub columns_info_for {
1644 my ($self, $table) = @_;
1645 $self->dbh_do('_dbh_columns_info_for', $table);
1648 =head2 last_insert_id
1650 Return the row id of the last insert.
1654 sub _dbh_last_insert_id {
1655 # All Storage's need to register their own _dbh_last_insert_id
1656 # the old SQLite-based method was highly inappropriate
1659 my $class = ref $self;
1660 $self->throw_exception (<<EOE);
1662 No _dbh_last_insert_id() method found in $class.
1663 Since the method of obtaining the autoincrement id of the last insert
1664 operation varies greatly between different databases, this method must be
1665 individually implemented for every storage class.
1669 sub last_insert_id {
1671 $self->dbh_do('_dbh_last_insert_id', @_);
1676 Returns the database driver name.
1680 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1682 =head2 bind_attribute_by_data_type
1684 Given a datatype from column info, returns a database specific bind
1685 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1686 let the database planner just handle it.
1688 Generally only needed for special case column types, like bytea in postgres.
1692 sub bind_attribute_by_data_type {
1696 =head2 create_ddl_dir (EXPERIMENTAL)
1700 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1704 Creates a SQL file based on the Schema, for each of the specified
1705 database engines in C<\@databases> in the given directory.
1706 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1708 Given a previous version number, this will also create a file containing
1709 the ALTER TABLE statements to transform the previous schema into the
1710 current one. Note that these statements may contain C<DROP TABLE> or
1711 C<DROP COLUMN> statements that can potentially destroy data.
1713 The file names are created using the C<ddl_filename> method below, please
1714 override this method in your schema if you would like a different file
1715 name format. For the ALTER file, the same format is used, replacing
1716 $version in the name with "$preversion-$version".
1718 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1719 The most common value for this would be C<< { add_drop_table => 1 } >>
1720 to have the SQL produced include a C<DROP TABLE> statement for each table
1721 created. For quoting purposes supply C<quote_table_names> and
1722 C<quote_field_names>.
1724 If no arguments are passed, then the following default values are assumed:
1728 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1730 =item version - $schema->schema_version
1732 =item directory - './'
1734 =item preversion - <none>
1738 By default, C<\%sqlt_args> will have
1740 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1742 merged with the hash passed in. To disable any of those features, pass in a
1743 hashref like the following
1745 { ignore_constraint_names => 0, # ... other options }
1748 Note that this feature is currently EXPERIMENTAL and may not work correctly
1749 across all databases, or fully handle complex relationships.
1751 WARNING: Please check all SQL files created, before applying them.
1755 sub create_ddl_dir {
1756 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1758 if(!$dir || !-d $dir) {
1759 carp "No directory given, using ./\n";
1762 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1763 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1765 my $schema_version = $schema->schema_version || '1.x';
1766 $version ||= $schema_version;
1769 add_drop_table => 1,
1770 ignore_constraint_names => 1,
1771 ignore_index_names => 1,
1775 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
1776 . $self->_check_sqlt_message . q{'})
1777 if !$self->_check_sqlt_version;
1779 my $sqlt = SQL::Translator->new( $sqltargs );
1781 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1782 my $sqlt_schema = $sqlt->translate({ data => $schema })
1783 or $self->throw_exception ($sqlt->error);
1785 foreach my $db (@$databases) {
1787 $sqlt->{schema} = $sqlt_schema;
1788 $sqlt->producer($db);
1791 my $filename = $schema->ddl_filename($db, $version, $dir);
1792 if (-e $filename && ($version eq $schema_version )) {
1793 # if we are dumping the current version, overwrite the DDL
1794 carp "Overwriting existing DDL file - $filename";
1798 my $output = $sqlt->translate;
1800 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1803 if(!open($file, ">$filename")) {
1804 $self->throw_exception("Can't open $filename for writing ($!)");
1807 print $file $output;
1810 next unless ($preversion);
1812 require SQL::Translator::Diff;
1814 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1815 if(!-e $prefilename) {
1816 carp("No previous schema file found ($prefilename)");
1820 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1822 carp("Overwriting existing diff file - $difffile");
1828 my $t = SQL::Translator->new($sqltargs);
1833 or $self->throw_exception ($t->error);
1835 my $out = $t->translate( $prefilename )
1836 or $self->throw_exception ($t->error);
1838 $source_schema = $t->schema;
1840 $source_schema->name( $prefilename )
1841 unless ( $source_schema->name );
1844 # The "new" style of producers have sane normalization and can support
1845 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
1846 # And we have to diff parsed SQL against parsed SQL.
1847 my $dest_schema = $sqlt_schema;
1849 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
1850 my $t = SQL::Translator->new($sqltargs);
1855 or $self->throw_exception ($t->error);
1857 my $out = $t->translate( $filename )
1858 or $self->throw_exception ($t->error);
1860 $dest_schema = $t->schema;
1862 $dest_schema->name( $filename )
1863 unless $dest_schema->name;
1866 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1870 if(!open $file, ">$difffile") {
1871 $self->throw_exception("Can't write to $difffile ($!)");
1879 =head2 deployment_statements
1883 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1887 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1889 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
1890 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
1892 C<$directory> is used to return statements from files in a previously created
1893 L</create_ddl_dir> directory and is optional. The filenames are constructed
1894 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1896 If no C<$directory> is specified then the statements are constructed on the
1897 fly using L<SQL::Translator> and C<$version> is ignored.
1899 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1903 sub deployment_statements {
1904 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1905 # Need to be connected to get the correct sqlt_type
1906 $self->ensure_connected() unless $type;
1907 $type ||= $self->sqlt_type;
1908 $version ||= $schema->schema_version || '1.x';
1910 my $filename = $schema->ddl_filename($type, $version, $dir);
1914 open($file, "<$filename")
1915 or $self->throw_exception("Can't open $filename ($!)");
1918 return join('', @rows);
1921 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
1922 . $self->_check_sqlt_message . q{'})
1923 if !$self->_check_sqlt_version;
1925 require SQL::Translator::Parser::DBIx::Class;
1926 eval qq{use SQL::Translator::Producer::${type}};
1927 $self->throw_exception($@) if $@;
1929 # sources needs to be a parser arg, but for simplicty allow at top level
1931 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1932 if exists $sqltargs->{sources};
1934 my $tr = SQL::Translator->new(%$sqltargs);
1935 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1936 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1940 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1943 return if($line =~ /^--/);
1945 # next if($line =~ /^DROP/m);
1946 return if($line =~ /^BEGIN TRANSACTION/m);
1947 return if($line =~ /^COMMIT/m);
1948 return if $line =~ /^\s+$/; # skip whitespace only
1949 $self->_query_start($line);
1951 $self->dbh->do($line); # shouldn't be using ->dbh ?
1954 carp qq{$@ (running "${line}")};
1956 $self->_query_end($line);
1958 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
1959 if (@statements > 1) {
1960 foreach my $statement (@statements) {
1961 $deploy->( $statement );
1964 elsif (@statements == 1) {
1965 foreach my $line ( split(";\n", $statements[0])) {
1971 =head2 datetime_parser
1973 Returns the datetime parser class
1977 sub datetime_parser {
1979 return $self->{datetime_parser} ||= do {
1980 $self->ensure_connected;
1981 $self->build_datetime_parser(@_);
1985 =head2 datetime_parser_type
1987 Defines (returns) the datetime parser class - currently hardwired to
1988 L<DateTime::Format::MySQL>
1992 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1994 =head2 build_datetime_parser
1996 See L</datetime_parser>
2000 sub build_datetime_parser {
2002 my $type = $self->datetime_parser_type(@_);
2004 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2009 my $_check_sqlt_version; # private
2010 my $_check_sqlt_message; # private
2011 sub _check_sqlt_version {
2012 return $_check_sqlt_version if defined $_check_sqlt_version;
2013 eval 'use SQL::Translator "0.09003"';
2014 $_check_sqlt_message = $@ || '';
2015 $_check_sqlt_version = !$@;
2018 sub _check_sqlt_message {
2019 _check_sqlt_version if !defined $_check_sqlt_message;
2020 $_check_sqlt_message;
2024 =head2 is_replicating
2026 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2027 replicate from a master database. Default is undef, which is the result
2028 returned by databases that don't support replication.
2032 sub is_replicating {
2037 =head2 lag_behind_master
2039 Returns a number that represents a certain amount of lag behind a master db
2040 when a given storage is replicating. The number is database dependent, but
2041 starts at zero and increases with the amount of lag. Default in undef
2045 sub lag_behind_master {
2051 return if !$self->_dbh;
2060 =head2 DBIx::Class and AutoCommit
2062 DBIx::Class can do some wonderful magic with handling exceptions,
2063 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2064 combined with C<txn_do> for transaction support.
2066 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2067 in an assumed transaction between commits, and you're telling us you'd
2068 like to manage that manually. A lot of the magic protections offered by
2069 this module will go away. We can't protect you from exceptions due to database
2070 disconnects because we don't know anything about how to restart your
2071 transactions. You're on your own for handling all sorts of exceptional
2072 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2079 Matt S. Trout <mst@shadowcatsystems.co.uk>
2081 Andy Grundman <andy@hybridized.org>
2085 You may distribute this code under the same terms as Perl itself.