All expected evals converted to try, except where no test is done,
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / Replicated.pm
1 package DBIx::Class::Storage::DBI::Replicated;
2
3 BEGIN {
4   use Carp::Clan qw/^DBIx::Class/;
5   use DBIx::Class;
6   croak('The following modules are required for Replication ' . DBIx::Class::Optional::Dependencies->req_missing_for ('replicated') )
7     unless DBIx::Class::Optional::Dependencies->req_ok_for ('replicated');
8 }
9
10 use Moose;
11 use DBIx::Class::Storage::DBI;
12 use DBIx::Class::Storage::DBI::Replicated::Pool;
13 use DBIx::Class::Storage::DBI::Replicated::Balancer;
14 use DBIx::Class::Storage::DBI::Replicated::Types qw/BalancerClassNamePart DBICSchema DBICStorageDBI/;
15 use MooseX::Types::Moose qw/ClassName HashRef Object/;
16 use Scalar::Util 'reftype';
17 use Hash::Merge;
18 use List::Util qw/min max reduce/;
19 use Try::Tiny;
20
21 use namespace::clean -except => 'meta';
22
23 =head1 NAME
24
25 DBIx::Class::Storage::DBI::Replicated - BETA Replicated database support
26
27 =head1 SYNOPSIS
28
29 The Following example shows how to change an existing $schema to a replicated
30 storage type, add some replicated (read-only) databases, and perform reporting
31 tasks.
32
33 You should set the 'storage_type attribute to a replicated type.  You should
34 also define your arguments, such as which balancer you want and any arguments
35 that the Pool object should get.
36
37   my $schema = Schema::Class->clone;
38   $schema->storage_type( ['::DBI::Replicated', {balancer=>'::Random'}] );
39   $schema->connection(...);
40
41 Next, you need to add in the Replicants.  Basically this is an array of 
42 arrayrefs, where each arrayref is database connect information.  Think of these
43 arguments as what you'd pass to the 'normal' $schema->connect method.
44
45   $schema->storage->connect_replicants(
46     [$dsn1, $user, $pass, \%opts],
47     [$dsn2, $user, $pass, \%opts],
48     [$dsn3, $user, $pass, \%opts],
49   );
50
51 Now, just use the $schema as you normally would.  Automatically all reads will
52 be delegated to the replicants, while writes to the master.
53
54   $schema->resultset('Source')->search({name=>'etc'});
55
56 You can force a given query to use a particular storage using the search
57 attribute 'force_pool'.  For example:
58
59   my $RS = $schema->resultset('Source')->search(undef, {force_pool=>'master'});
60
61 Now $RS will force everything (both reads and writes) to use whatever was setup
62 as the master storage.  'master' is hardcoded to always point to the Master, 
63 but you can also use any Replicant name.  Please see:
64 L<DBIx::Class::Storage::DBI::Replicated::Pool> and the replicants attribute for more.
65
66 Also see transactions and L</execute_reliably> for alternative ways to
67 force read traffic to the master.  In general, you should wrap your statements
68 in a transaction when you are reading and writing to the same tables at the
69 same time, since your replicants will often lag a bit behind the master.
70
71 See L<DBIx::Class::Storage::DBI::Replicated::Instructions> for more help and
72 walkthroughs.
73
74 =head1 DESCRIPTION
75
76 Warning: This class is marked BETA.  This has been running a production
77 website using MySQL native replication as its backend and we have some decent
78 test coverage but the code hasn't yet been stressed by a variety of databases.
79 Individual DBs may have quirks we are not aware of.  Please use this in first
80 development and pass along your experiences/bug fixes.
81
82 This class implements replicated data store for DBI. Currently you can define
83 one master and numerous slave database connections. All write-type queries
84 (INSERT, UPDATE, DELETE and even LAST_INSERT_ID) are routed to master
85 database, all read-type queries (SELECTs) go to the slave database.
86
87 Basically, any method request that L<DBIx::Class::Storage::DBI> would normally
88 handle gets delegated to one of the two attributes: L</read_handler> or to
89 L</write_handler>.  Additionally, some methods need to be distributed
90 to all existing storages.  This way our storage class is a drop in replacement
91 for L<DBIx::Class::Storage::DBI>.
92
93 Read traffic is spread across the replicants (slaves) occurring to a user
94 selected algorithm.  The default algorithm is random weighted.
95
96 =head1 NOTES
97
98 The consistency between master and replicants is database specific.  The Pool
99 gives you a method to validate its replicants, removing and replacing them
100 when they fail/pass predefined criteria.  Please make careful use of the ways
101 to force a query to run against Master when needed.
102
103 =head1 REQUIREMENTS
104
105 Replicated Storage has additional requirements not currently part of
106 L<DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details.
107
108 =head1 ATTRIBUTES
109
110 This class defines the following attributes.
111
112 =head2 schema
113
114 The underlying L<DBIx::Class::Schema> object this storage is attaching
115
116 =cut
117
118 has 'schema' => (
119     is=>'rw',
120     isa=>DBICSchema,
121     weak_ref=>1,
122     required=>1,
123 );
124
125 =head2 pool_type
126
127 Contains the classname which will instantiate the L</pool> object.  Defaults 
128 to: L<DBIx::Class::Storage::DBI::Replicated::Pool>.
129
130 =cut
131
132 has 'pool_type' => (
133   is=>'rw',
134   isa=>ClassName,
135   default=>'DBIx::Class::Storage::DBI::Replicated::Pool',
136   handles=>{
137     'create_pool' => 'new',
138   },
139 );
140
141 =head2 pool_args
142
143 Contains a hashref of initialized information to pass to the Balancer object.
144 See L<DBIx::Class::Storage::DBI::Replicated::Pool> for available arguments.
145
146 =cut
147
148 has 'pool_args' => (
149   is=>'rw',
150   isa=>HashRef,
151   lazy=>1,
152   default=>sub { {} },
153 );
154
155
156 =head2 balancer_type
157
158 The replication pool requires a balance class to provider the methods for
159 choose how to spread the query load across each replicant in the pool.
160
161 =cut
162
163 has 'balancer_type' => (
164   is=>'rw',
165   isa=>BalancerClassNamePart,
166   coerce=>1,
167   required=>1,
168   default=> 'DBIx::Class::Storage::DBI::Replicated::Balancer::First',
169   handles=>{
170     'create_balancer' => 'new',
171   },
172 );
173
174 =head2 balancer_args
175
176 Contains a hashref of initialized information to pass to the Balancer object.
177 See L<DBIx::Class::Storage::DBI::Replicated::Balancer> for available arguments.
178
179 =cut
180
181 has 'balancer_args' => (
182   is=>'rw',
183   isa=>HashRef,
184   lazy=>1,
185   required=>1,
186   default=>sub { {} },
187 );
188
189 =head2 pool
190
191 Is a <DBIx::Class::Storage::DBI::Replicated::Pool> or derived class.  This is a
192 container class for one or more replicated databases.
193
194 =cut
195
196 has 'pool' => (
197   is=>'ro',
198   isa=>'DBIx::Class::Storage::DBI::Replicated::Pool',
199   lazy_build=>1,
200   handles=>[qw/
201     connect_replicants
202     replicants
203     has_replicants
204   /],
205 );
206
207 =head2 balancer
208
209 Is a <DBIx::Class::Storage::DBI::Replicated::Balancer> or derived class.  This 
210 is a class that takes a pool (<DBIx::Class::Storage::DBI::Replicated::Pool>)
211
212 =cut
213
214 has 'balancer' => (
215   is=>'rw',
216   isa=>'DBIx::Class::Storage::DBI::Replicated::Balancer',
217   lazy_build=>1,
218   handles=>[qw/auto_validate_every/],
219 );
220
221 =head2 master
222
223 The master defines the canonical state for a pool of connected databases.  All
224 the replicants are expected to match this databases state.  Thus, in a classic
225 Master / Slaves distributed system, all the slaves are expected to replicate
226 the Master's state as quick as possible.  This is the only database in the
227 pool of databases that is allowed to handle write traffic.
228
229 =cut
230
231 has 'master' => (
232   is=> 'ro',
233   isa=>DBICStorageDBI,
234   lazy_build=>1,
235 );
236
237 =head1 ATTRIBUTES IMPLEMENTING THE DBIx::Storage::DBI INTERFACE
238
239 The following methods are delegated all the methods required for the 
240 L<DBIx::Class::Storage::DBI> interface.
241
242 =head2 read_handler
243
244 Defines an object that implements the read side of L<BIx::Class::Storage::DBI>.
245
246 =cut
247
248 has 'read_handler' => (
249   is=>'rw',
250   isa=>Object,
251   lazy_build=>1,
252   handles=>[qw/
253     select
254     select_single
255     columns_info_for
256     _dbh_columns_info_for 
257     _select
258   /],
259 );
260
261 =head2 write_handler
262
263 Defines an object that implements the write side of L<BIx::Class::Storage::DBI>,
264 as well as methods that don't write or read that can be called on only one
265 storage, methods that return a C<$dbh>, and any methods that don't make sense to
266 run on a replicant.
267
268 =cut
269
270 has 'write_handler' => (
271   is=>'ro',
272   isa=>Object,
273   lazy_build=>1,
274   handles=>[qw/
275     on_connect_do
276     on_disconnect_do
277     on_connect_call
278     on_disconnect_call
279     connect_info
280     _connect_info
281     throw_exception
282     sql_maker
283     sqlt_type
284     create_ddl_dir
285     deployment_statements
286     datetime_parser
287     datetime_parser_type
288     build_datetime_parser
289     last_insert_id
290     insert
291     insert_bulk
292     update
293     delete
294     dbh
295     txn_begin
296     txn_do
297     txn_commit
298     txn_rollback
299     txn_scope_guard
300     sth
301     deploy
302     with_deferred_fk_checks
303     dbh_do
304     reload_row
305     with_deferred_fk_checks
306     _prep_for_execute
307
308     backup
309     is_datatype_numeric
310     _supports_insert_returning
311     _count_select
312     _subq_update_delete
313     svp_rollback
314     svp_begin
315     svp_release
316     relname_to_table_alias
317     _straight_join_to_node
318     _dbh_last_insert_id
319     _fix_bind_params
320     _default_dbi_connect_attributes
321     _dbi_connect_info
322     auto_savepoint
323     _sqlt_version_ok
324     _query_end
325     bind_attribute_by_data_type
326     transaction_depth
327     _dbh
328     _select_args
329     _dbh_execute_array
330     _sql_maker_args
331     _sql_maker
332     _query_start
333     _sqlt_version_error
334     _per_row_update_delete
335     _dbh_begin_work
336     _dbh_execute_inserts_with_no_binds
337     _select_args_to_query
338     _svp_generate_name
339     _multipk_update_delete
340     source_bind_attributes
341     _normalize_connect_info
342     _parse_connect_do
343     _dbh_commit
344     _execute_array
345     _placeholders_supported
346     savepoints
347     _sqlt_minimum_version
348     _sql_maker_opts
349     _conn_pid
350     _typeless_placeholders_supported
351     _conn_tid
352     _dbh_autocommit
353     _native_data_type
354     _get_dbh
355     sql_maker_class
356     _dbh_rollback
357     _adjust_select_args_for_complex_prefetch
358     _resolve_ident_sources
359     _resolve_column_info
360     _prune_unused_joins
361     _strip_cond_qualifiers
362     _parse_order_by
363     _resolve_aliastypes_from_select_args
364     _execute
365     _do_query
366     _dbh_sth
367     _dbh_execute
368     _prefetch_insert_auto_nextvals
369     _server_info_hash
370   /],
371 );
372
373 my @unimplemented = qw(
374   _arm_global_destructor
375   _preserve_foreign_dbh
376   _verify_pid
377   _verify_tid
378 );
379
380 for my $method (@unimplemented) {
381   __PACKAGE__->meta->add_method($method, sub {
382     croak "$method must not be called on ".(blessed shift).' objects';
383   });
384 }
385
386 has _master_connect_info_opts =>
387   (is => 'rw', isa => HashRef, default => sub { {} });
388
389 =head2 around: connect_info
390
391 Preserves master's C<connect_info> options (for merging with replicants.)
392 Also sets any Replicated-related options from connect_info, such as
393 C<pool_type>, C<pool_args>, C<balancer_type> and C<balancer_args>.
394
395 =cut
396
397 around connect_info => sub {
398   my ($next, $self, $info, @extra) = @_;
399
400   my $wantarray = wantarray;
401
402   my $merge = Hash::Merge->new('LEFT_PRECEDENT');
403
404   my %opts;
405   for my $arg (@$info) {
406     next unless (reftype($arg)||'') eq 'HASH';
407     %opts = %{ $merge->merge($arg, \%opts) };
408   }
409   delete $opts{dsn};
410
411   if (@opts{qw/pool_type pool_args/}) {
412     $self->pool_type(delete $opts{pool_type})
413       if $opts{pool_type};
414
415     $self->pool_args(
416       $merge->merge((delete $opts{pool_args} || {}), $self->pool_args)
417     );
418
419     $self->pool($self->_build_pool)
420       if $self->pool;
421   }
422
423   if (@opts{qw/balancer_type balancer_args/}) {
424     $self->balancer_type(delete $opts{balancer_type})
425       if $opts{balancer_type};
426
427     $self->balancer_args(
428       $merge->merge((delete $opts{balancer_args} || {}), $self->balancer_args)
429     );
430
431     $self->balancer($self->_build_balancer)
432       if $self->balancer;
433   }
434
435   $self->_master_connect_info_opts(\%opts);
436
437   my (@res, $res);
438   if ($wantarray) {
439     @res = $self->$next($info, @extra);
440   } else {
441     $res = $self->$next($info, @extra);
442   }
443
444   # Make sure master is blessed into the correct class and apply role to it.
445   my $master = $self->master;
446   $master->_determine_driver;
447   Moose::Meta::Class->initialize(ref $master);
448
449   DBIx::Class::Storage::DBI::Replicated::WithDSN->meta->apply($master);
450
451   # link pool back to master
452   $self->pool->master($master);
453
454   $wantarray ? @res : $res;
455 };
456
457 =head1 METHODS
458
459 This class defines the following methods.
460
461 =head2 BUILDARGS
462
463 L<DBIx::Class::Schema> when instantiating its storage passed itself as the
464 first argument.  So we need to massage the arguments a bit so that all the
465 bits get put into the correct places.
466
467 =cut
468
469 sub BUILDARGS {
470   my ($class, $schema, $storage_type_args, @args) = @_;  
471
472   return {
473     schema=>$schema,
474     %$storage_type_args,
475     @args
476   }
477 }
478
479 =head2 _build_master
480
481 Lazy builder for the L</master> attribute.
482
483 =cut
484
485 sub _build_master {
486   my $self = shift @_;
487   my $master = DBIx::Class::Storage::DBI->new($self->schema);
488   $master
489 }
490
491 =head2 _build_pool
492
493 Lazy builder for the L</pool> attribute.
494
495 =cut
496
497 sub _build_pool {
498   my $self = shift @_;
499   $self->create_pool(%{$self->pool_args});
500 }
501
502 =head2 _build_balancer
503
504 Lazy builder for the L</balancer> attribute.  This takes a Pool object so that
505 the balancer knows which pool it's balancing.
506
507 =cut
508
509 sub _build_balancer {
510   my $self = shift @_;
511   $self->create_balancer(
512     pool=>$self->pool,
513     master=>$self->master,
514     %{$self->balancer_args},
515   );
516 }
517
518 =head2 _build_write_handler
519
520 Lazy builder for the L</write_handler> attribute.  The default is to set this to
521 the L</master>.
522
523 =cut
524
525 sub _build_write_handler {
526   return shift->master;
527 }
528
529 =head2 _build_read_handler
530
531 Lazy builder for the L</read_handler> attribute.  The default is to set this to
532 the L</balancer>.
533
534 =cut
535
536 sub _build_read_handler {
537   return shift->balancer;
538 }
539
540 =head2 around: connect_replicants
541
542 All calls to connect_replicants needs to have an existing $schema tacked onto
543 top of the args, since L<DBIx::Storage::DBI> needs it, and any C<connect_info>
544 options merged with the master, with replicant opts having higher priority.
545
546 =cut
547
548 around connect_replicants => sub {
549   my ($next, $self, @args) = @_;
550
551   for my $r (@args) {
552     $r = [ $r ] unless reftype $r eq 'ARRAY';
553
554     $self->throw_exception('coderef replicant connect_info not supported')
555       if ref $r->[0] && reftype $r->[0] eq 'CODE';
556
557 # any connect_info options?
558     my $i = 0;
559     $i++ while $i < @$r && (reftype($r->[$i])||'') ne 'HASH';
560
561 # make one if none
562     $r->[$i] = {} unless $r->[$i];
563
564 # merge if two hashes
565     my @hashes = @$r[$i .. $#{$r}];
566
567     $self->throw_exception('invalid connect_info options')
568       if (grep { reftype($_) eq 'HASH' } @hashes) != @hashes;
569
570     $self->throw_exception('too many hashrefs in connect_info')
571       if @hashes > 2;
572
573     my $merge = Hash::Merge->new('LEFT_PRECEDENT');
574     my %opts = %{ $merge->merge(reverse @hashes) };
575
576 # delete them
577     splice @$r, $i+1, ($#{$r} - $i), ();
578
579 # make sure master/replicants opts don't clash
580     my %master_opts = %{ $self->_master_connect_info_opts };
581     if (exists $opts{dbh_maker}) {
582         delete @master_opts{qw/dsn user password/};
583     }
584     delete $master_opts{dbh_maker};
585
586 # merge with master
587     %opts = %{ $merge->merge(\%opts, \%master_opts) };
588
589 # update
590     $r->[$i] = \%opts;
591   }
592
593   $self->$next($self->schema, @args);
594 };
595
596 =head2 all_storages
597
598 Returns an array of of all the connected storage backends.  The first element
599 in the returned array is the master, and the remainings are each of the
600 replicants.
601
602 =cut
603
604 sub all_storages {
605   my $self = shift @_;
606   return grep {defined $_ && blessed $_} (
607      $self->master,
608      values %{ $self->replicants },
609   );
610 }
611
612 =head2 execute_reliably ($coderef, ?@args)
613
614 Given a coderef, saves the current state of the L</read_handler>, forces it to
615 use reliable storage (e.g. sets it to the master), executes a coderef and then
616 restores the original state.
617
618 Example:
619
620   my $reliably = sub {
621     my $name = shift @_;
622     $schema->resultset('User')->create({name=>$name});
623     my $user_rs = $schema->resultset('User')->find({name=>$name}); 
624     return $user_rs;
625   };
626
627   my $user_rs = $schema->storage->execute_reliably($reliably, 'John');
628
629 Use this when you must be certain of your database state, such as when you just
630 inserted something and need to get a resultset including it, etc.
631
632 =cut
633
634 sub execute_reliably {
635   my ($self, $coderef, @args) = @_;
636
637   unless( ref $coderef eq 'CODE') {
638     $self->throw_exception('Second argument must be a coderef');
639   }
640
641   ##Get copy of master storage
642   my $master = $self->master;
643
644   ##Get whatever the current read hander is
645   my $current = $self->read_handler;
646
647   ##Set the read handler to master
648   $self->read_handler($master);
649
650   ## do whatever the caller needs
651   my @result;
652   my $want_array = wantarray;
653
654   my $exception;
655   try {
656     if($want_array) {
657       @result = $coderef->(@args);
658     } elsif(defined $want_array) {
659       ($result[0]) = ($coderef->(@args));
660     } else {
661       $coderef->(@args);
662     }
663   } catch {
664     $self->throw_exception("coderef returned an error: $_");
665   } finally {
666     ##Reset to the original state
667     $self->read_handler($current);
668   };
669
670   return $want_array ? @result : $result[0];
671 }
672
673 =head2 set_reliable_storage
674
675 Sets the current $schema to be 'reliable', that is all queries, both read and
676 write are sent to the master
677
678 =cut
679
680 sub set_reliable_storage {
681   my $self = shift @_;
682   my $schema = $self->schema;
683   my $write_handler = $self->schema->storage->write_handler;
684
685   $schema->storage->read_handler($write_handler);
686 }
687
688 =head2 set_balanced_storage
689
690 Sets the current $schema to be use the </balancer> for all reads, while all
691 writes are sent to the master only
692
693 =cut
694
695 sub set_balanced_storage {
696   my $self = shift @_;
697   my $schema = $self->schema;
698   my $balanced_handler = $self->schema->storage->balancer;
699
700   $schema->storage->read_handler($balanced_handler);
701 }
702
703 =head2 connected
704
705 Check that the master and at least one of the replicants is connected.
706
707 =cut
708
709 sub connected {
710   my $self = shift @_;
711   return
712     $self->master->connected &&
713     $self->pool->connected_replicants;
714 }
715
716 =head2 ensure_connected
717
718 Make sure all the storages are connected.
719
720 =cut
721
722 sub ensure_connected {
723   my $self = shift @_;
724   foreach my $source ($self->all_storages) {
725     $source->ensure_connected(@_);
726   }
727 }
728
729 =head2 limit_dialect
730
731 Set the limit_dialect for all existing storages
732
733 =cut
734
735 sub limit_dialect {
736   my $self = shift @_;
737   foreach my $source ($self->all_storages) {
738     $source->limit_dialect(@_);
739   }
740   return $self->master->quote_char;
741 }
742
743 =head2 quote_char
744
745 Set the quote_char for all existing storages
746
747 =cut
748
749 sub quote_char {
750   my $self = shift @_;
751   foreach my $source ($self->all_storages) {
752     $source->quote_char(@_);
753   }
754   return $self->master->quote_char;
755 }
756
757 =head2 name_sep
758
759 Set the name_sep for all existing storages
760
761 =cut
762
763 sub name_sep {
764   my $self = shift @_;
765   foreach my $source ($self->all_storages) {
766     $source->name_sep(@_);
767   }
768   return $self->master->name_sep;
769 }
770
771 =head2 set_schema
772
773 Set the schema object for all existing storages
774
775 =cut
776
777 sub set_schema {
778   my $self = shift @_;
779   foreach my $source ($self->all_storages) {
780     $source->set_schema(@_);
781   }
782 }
783
784 =head2 debug
785
786 set a debug flag across all storages
787
788 =cut
789
790 sub debug {
791   my $self = shift @_;
792   if(@_) {
793     foreach my $source ($self->all_storages) {
794       $source->debug(@_);
795     }
796   }
797   return $self->master->debug;
798 }
799
800 =head2 debugobj
801
802 set a debug object
803
804 =cut
805
806 sub debugobj {
807   my $self = shift @_;
808   return $self->master->debugobj(@_);
809 }
810
811 =head2 debugfh
812
813 set a debugfh object
814
815 =cut
816
817 sub debugfh {
818   my $self = shift @_;
819   return $self->master->debugfh(@_);
820 }
821
822 =head2 debugcb
823
824 set a debug callback
825
826 =cut
827
828 sub debugcb {
829   my $self = shift @_;
830   return $self->master->debugcb(@_);
831 }
832
833 =head2 disconnect
834
835 disconnect everything
836
837 =cut
838
839 sub disconnect {
840   my $self = shift @_;
841   foreach my $source ($self->all_storages) {
842     $source->disconnect(@_);
843   }
844 }
845
846 =head2 cursor_class
847
848 set cursor class on all storages, or return master's
849
850 =cut
851
852 sub cursor_class {
853   my ($self, $cursor_class) = @_;
854
855   if ($cursor_class) {
856     $_->cursor_class($cursor_class) for $self->all_storages;
857   }
858   $self->master->cursor_class;
859 }
860
861 =head2 cursor
862
863 set cursor class on all storages, or return master's, alias for L</cursor_class>
864 above.
865
866 =cut
867
868 sub cursor {
869   my ($self, $cursor_class) = @_;
870
871   if ($cursor_class) {
872     $_->cursor($cursor_class) for $self->all_storages;
873   }
874   $self->master->cursor;
875 }
876
877 =head2 unsafe
878
879 sets the L<DBIx::Class::Storage::DBI/unsafe> option on all storages or returns
880 master's current setting
881
882 =cut
883
884 sub unsafe {
885   my $self = shift;
886
887   if (@_) {
888     $_->unsafe(@_) for $self->all_storages;
889   }
890
891   return $self->master->unsafe;
892 }
893
894 =head2 disable_sth_caching
895
896 sets the L<DBIx::Class::Storage::DBI/disable_sth_caching> option on all storages
897 or returns master's current setting
898
899 =cut
900
901 sub disable_sth_caching {
902   my $self = shift;
903
904   if (@_) {
905     $_->disable_sth_caching(@_) for $self->all_storages;
906   }
907
908   return $self->master->disable_sth_caching;
909 }
910
911 =head2 lag_behind_master
912
913 returns the highest Replicant L<DBIx::Class::Storage::DBI/lag_behind_master>
914 setting
915
916 =cut
917
918 sub lag_behind_master {
919   my $self = shift;
920
921   return max map $_->lag_behind_master, $self->replicants;
922
923
924 =head2 is_replicating
925
926 returns true if all replicants return true for
927 L<DBIx::Class::Storage::DBI/is_replicating>
928
929 =cut
930
931 sub is_replicating {
932   my $self = shift;
933
934   return (grep $_->is_replicating, $self->replicants) == ($self->replicants);
935 }
936
937 =head2 connect_call_datetime_setup
938
939 calls L<DBIx::Class::Storage::DBI/connect_call_datetime_setup> for all storages
940
941 =cut
942
943 sub connect_call_datetime_setup {
944   my $self = shift;
945   $_->connect_call_datetime_setup for $self->all_storages;
946 }
947
948 sub _populate_dbh {
949   my $self = shift;
950   $_->_populate_dbh for $self->all_storages;
951 }
952
953 sub _connect {
954   my $self = shift;
955   $_->_connect for $self->all_storages;
956 }
957
958 sub _rebless {
959   my $self = shift;
960   $_->_rebless for $self->all_storages;
961 }
962
963 sub _determine_driver {
964   my $self = shift;
965   $_->_determine_driver for $self->all_storages;
966 }
967
968 sub _driver_determined {
969   my $self = shift;
970   
971   if (@_) {
972     $_->_driver_determined(@_) for $self->all_storages;
973   }
974
975   return $self->master->_driver_determined;
976 }
977
978 sub _init {
979   my $self = shift;
980   
981   $_->_init for $self->all_storages;
982 }
983
984 sub _run_connection_actions {
985   my $self = shift;
986   
987   $_->_run_connection_actions for $self->all_storages;
988 }
989
990 sub _do_connection_actions {
991   my $self = shift;
992   
993   if (@_) {
994     $_->_do_connection_actions(@_) for $self->all_storages;
995   }
996 }
997
998 sub connect_call_do_sql {
999   my $self = shift;
1000   $_->connect_call_do_sql(@_) for $self->all_storages;
1001 }
1002
1003 sub disconnect_call_do_sql {
1004   my $self = shift;
1005   $_->disconnect_call_do_sql(@_) for $self->all_storages;
1006 }
1007
1008 sub _seems_connected {
1009   my $self = shift;
1010
1011   return min map $_->_seems_connected, $self->all_storages;
1012 }
1013
1014 sub _ping {
1015   my $self = shift;
1016
1017   return min map $_->_ping, $self->all_storages;
1018 }
1019
1020 my $numify_ver = sub {
1021   my $ver = shift;
1022   my @numparts = split /\D+/, $ver;
1023   my $format = '%d.' . (join '', ('%05d') x (@numparts - 1));
1024
1025   return sprintf $format, @numparts;
1026 };
1027
1028 sub _server_info {
1029   my $self = shift;
1030
1031   if (not $self->_server_info_hash) {
1032     my $min_version_info = (
1033       reduce { $a->[0] < $b->[0] ? $a : $b } 
1034       map [ $numify_ver->($_->{dbms_version}), $_ ],
1035       map $_->_server_info, $self->all_storages
1036     )->[1];
1037
1038     $self->_server_info_hash($min_version_info); # on master
1039   }
1040
1041   return $self->_server_info_hash;
1042 }
1043
1044 sub _get_server_version {
1045   my $self = shift;
1046
1047   return $self->_server_info->{dbms_version};
1048 }
1049
1050 =head1 GOTCHAS
1051
1052 Due to the fact that replicants can lag behind a master, you must take care to
1053 make sure you use one of the methods to force read queries to a master should
1054 you need realtime data integrity.  For example, if you insert a row, and then
1055 immediately re-read it from the database (say, by doing $row->discard_changes)
1056 or you insert a row and then immediately build a query that expects that row
1057 to be an item, you should force the master to handle reads.  Otherwise, due to
1058 the lag, there is no certainty your data will be in the expected state.
1059
1060 For data integrity, all transactions automatically use the master storage for
1061 all read and write queries.  Using a transaction is the preferred and recommended
1062 method to force the master to handle all read queries.
1063
1064 Otherwise, you can force a single query to use the master with the 'force_pool'
1065 attribute:
1066
1067   my $row = $resultset->search(undef, {force_pool=>'master'})->find($pk);
1068
1069 This attribute will safely be ignore by non replicated storages, so you can use
1070 the same code for both types of systems.
1071
1072 Lastly, you can use the L</execute_reliably> method, which works very much like
1073 a transaction.
1074
1075 For debugging, you can turn replication on/off with the methods L</set_reliable_storage>
1076 and L</set_balanced_storage>, however this operates at a global level and is not
1077 suitable if you have a shared Schema object being used by multiple processes,
1078 such as on a web application server.  You can get around this limitation by
1079 using the Schema clone method.
1080
1081   my $new_schema = $schema->clone;
1082   $new_schema->set_reliable_storage;
1083
1084   ## $new_schema will use only the Master storage for all reads/writes while
1085   ## the $schema object will use replicated storage.
1086
1087 =head1 AUTHOR
1088
1089   John Napiorkowski <john.napiorkowski@takkle.com>
1090
1091 Based on code originated by:
1092
1093   Norbert Csongrádi <bert@cpan.org>
1094   Peter Siklósi <einon@einon.hu>
1095
1096 =head1 LICENSE
1097
1098 You may distribute this code under the same terms as Perl itself.
1099
1100 =cut
1101
1102 __PACKAGE__->meta->make_immutable;
1103
1104 1;