Test cleanup
[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 use namespace::clean;
21
22 use namespace::clean -except => 'meta';
23
24 =head1 NAME
25
26 DBIx::Class::Storage::DBI::Replicated - BETA Replicated database support
27
28 =head1 SYNOPSIS
29
30 The Following example shows how to change an existing $schema to a replicated
31 storage type, add some replicated (read-only) databases, and perform reporting
32 tasks.
33
34 You should set the 'storage_type attribute to a replicated type.  You should
35 also define your arguments, such as which balancer you want and any arguments
36 that the Pool object should get.
37
38   my $schema = Schema::Class->clone;
39   $schema->storage_type( ['::DBI::Replicated', {balancer=>'::Random'}] );
40   $schema->connection(...);
41
42 Next, you need to add in the Replicants.  Basically this is an array of
43 arrayrefs, where each arrayref is database connect information.  Think of these
44 arguments as what you'd pass to the 'normal' $schema->connect method.
45
46   $schema->storage->connect_replicants(
47     [$dsn1, $user, $pass, \%opts],
48     [$dsn2, $user, $pass, \%opts],
49     [$dsn3, $user, $pass, \%opts],
50   );
51
52 Now, just use the $schema as you normally would.  Automatically all reads will
53 be delegated to the replicants, while writes to the master.
54
55   $schema->resultset('Source')->search({name=>'etc'});
56
57 You can force a given query to use a particular storage using the search
58 attribute 'force_pool'.  For example:
59
60   my $RS = $schema->resultset('Source')->search(undef, {force_pool=>'master'});
61
62 Now $RS will force everything (both reads and writes) to use whatever was setup
63 as the master storage.  'master' is hardcoded to always point to the Master,
64 but you can also use any Replicant name.  Please see:
65 L<DBIx::Class::Storage::DBI::Replicated::Pool> and the replicants attribute for more.
66
67 Also see transactions and L</execute_reliably> for alternative ways to
68 force read traffic to the master.  In general, you should wrap your statements
69 in a transaction when you are reading and writing to the same tables at the
70 same time, since your replicants will often lag a bit behind the master.
71
72 See L<DBIx::Class::Storage::DBI::Replicated::Instructions> for more help and
73 walkthroughs.
74
75 =head1 DESCRIPTION
76
77 Warning: This class is marked BETA.  This has been running a production
78 website using MySQL native replication as its backend and we have some decent
79 test coverage but the code hasn't yet been stressed by a variety of databases.
80 Individual DBs may have quirks we are not aware of.  Please use this in first
81 development and pass along your experiences/bug fixes.
82
83 This class implements replicated data store for DBI. Currently you can define
84 one master and numerous slave database connections. All write-type queries
85 (INSERT, UPDATE, DELETE and even LAST_INSERT_ID) are routed to master
86 database, all read-type queries (SELECTs) go to the slave database.
87
88 Basically, any method request that L<DBIx::Class::Storage::DBI> would normally
89 handle gets delegated to one of the two attributes: L</read_handler> or to
90 L</write_handler>.  Additionally, some methods need to be distributed
91 to all existing storages.  This way our storage class is a drop in replacement
92 for L<DBIx::Class::Storage::DBI>.
93
94 Read traffic is spread across the replicants (slaves) occurring to a user
95 selected algorithm.  The default algorithm is random weighted.
96
97 =head1 NOTES
98
99 The consistency between master and replicants is database specific.  The Pool
100 gives you a method to validate its replicants, removing and replacing them
101 when they fail/pass predefined criteria.  Please make careful use of the ways
102 to force a query to run against Master when needed.
103
104 =head1 REQUIREMENTS
105
106 Replicated Storage has additional requirements not currently part of
107 L<DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details.
108
109 =head1 ATTRIBUTES
110
111 This class defines the following attributes.
112
113 =head2 schema
114
115 The underlying L<DBIx::Class::Schema> object this storage is attaching
116
117 =cut
118
119 has 'schema' => (
120     is=>'rw',
121     isa=>DBICSchema,
122     weak_ref=>1,
123     required=>1,
124 );
125
126 =head2 pool_type
127
128 Contains the classname which will instantiate the L</pool> object.  Defaults
129 to: L<DBIx::Class::Storage::DBI::Replicated::Pool>.
130
131 =cut
132
133 has 'pool_type' => (
134   is=>'rw',
135   isa=>ClassName,
136   default=>'DBIx::Class::Storage::DBI::Replicated::Pool',
137   handles=>{
138     'create_pool' => 'new',
139   },
140 );
141
142 =head2 pool_args
143
144 Contains a hashref of initialized information to pass to the Balancer object.
145 See L<DBIx::Class::Storage::DBI::Replicated::Pool> for available arguments.
146
147 =cut
148
149 has 'pool_args' => (
150   is=>'rw',
151   isa=>HashRef,
152   lazy=>1,
153   default=>sub { {} },
154 );
155
156
157 =head2 balancer_type
158
159 The replication pool requires a balance class to provider the methods for
160 choose how to spread the query load across each replicant in the pool.
161
162 =cut
163
164 has 'balancer_type' => (
165   is=>'rw',
166   isa=>BalancerClassNamePart,
167   coerce=>1,
168   required=>1,
169   default=> 'DBIx::Class::Storage::DBI::Replicated::Balancer::First',
170   handles=>{
171     'create_balancer' => 'new',
172   },
173 );
174
175 =head2 balancer_args
176
177 Contains a hashref of initialized information to pass to the Balancer object.
178 See L<DBIx::Class::Storage::DBI::Replicated::Balancer> for available arguments.
179
180 =cut
181
182 has 'balancer_args' => (
183   is=>'rw',
184   isa=>HashRef,
185   lazy=>1,
186   required=>1,
187   default=>sub { {} },
188 );
189
190 =head2 pool
191
192 Is a <DBIx::Class::Storage::DBI::Replicated::Pool> or derived class.  This is a
193 container class for one or more replicated databases.
194
195 =cut
196
197 has 'pool' => (
198   is=>'ro',
199   isa=>'DBIx::Class::Storage::DBI::Replicated::Pool',
200   lazy_build=>1,
201   handles=>[qw/
202     connect_replicants
203     replicants
204     has_replicants
205   /],
206 );
207
208 =head2 balancer
209
210 Is a <DBIx::Class::Storage::DBI::Replicated::Balancer> or derived class.  This
211 is a class that takes a pool (<DBIx::Class::Storage::DBI::Replicated::Pool>)
212
213 =cut
214
215 has 'balancer' => (
216   is=>'rw',
217   isa=>'DBIx::Class::Storage::DBI::Replicated::Balancer',
218   lazy_build=>1,
219   handles=>[qw/auto_validate_every/],
220 );
221
222 =head2 master
223
224 The master defines the canonical state for a pool of connected databases.  All
225 the replicants are expected to match this databases state.  Thus, in a classic
226 Master / Slaves distributed system, all the slaves are expected to replicate
227 the Master's state as quick as possible.  This is the only database in the
228 pool of databases that is allowed to handle write traffic.
229
230 =cut
231
232 has 'master' => (
233   is=> 'ro',
234   isa=>DBICStorageDBI,
235   lazy_build=>1,
236 );
237
238 =head1 ATTRIBUTES IMPLEMENTING THE DBIx::Storage::DBI INTERFACE
239
240 The following methods are delegated all the methods required for the
241 L<DBIx::Class::Storage::DBI> interface.
242
243 =head2 read_handler
244
245 Defines an object that implements the read side of L<BIx::Class::Storage::DBI>.
246
247 =cut
248
249 has 'read_handler' => (
250   is=>'rw',
251   isa=>Object,
252   lazy_build=>1,
253   handles=>[qw/
254     select
255     select_single
256     columns_info_for
257     _dbh_columns_info_for
258     _select
259   /],
260 );
261
262 =head2 write_handler
263
264 Defines an object that implements the write side of L<BIx::Class::Storage::DBI>,
265 as well as methods that don't write or read that can be called on only one
266 storage, methods that return a C<$dbh>, and any methods that don't make sense to
267 run on a replicant.
268
269 =cut
270
271 has 'write_handler' => (
272   is=>'ro',
273   isa=>Object,
274   lazy_build=>1,
275   handles=>[qw/
276     on_connect_do
277     on_disconnect_do
278     on_connect_call
279     on_disconnect_call
280     connect_info
281     _connect_info
282     throw_exception
283     sql_maker
284     sqlt_type
285     create_ddl_dir
286     deployment_statements
287     datetime_parser
288     datetime_parser_type
289     build_datetime_parser
290     last_insert_id
291     insert
292     insert_bulk
293     update
294     delete
295     dbh
296     txn_begin
297     txn_do
298     txn_commit
299     txn_rollback
300     txn_scope_guard
301     sth
302     deploy
303     with_deferred_fk_checks
304     dbh_do
305     reload_row
306     with_deferred_fk_checks
307     _prep_for_execute
308
309     backup
310     is_datatype_numeric
311     _supports_insert_returning
312     _count_select
313     _subq_update_delete
314     svp_rollback
315     svp_begin
316     svp_release
317     relname_to_table_alias
318     _straight_join_to_node
319     _dbh_last_insert_id
320     _fix_bind_params
321     _default_dbi_connect_attributes
322     _dbi_connect_info
323     auto_savepoint
324     _sqlt_version_ok
325     _query_end
326     bind_attribute_by_data_type
327     transaction_depth
328     _dbh
329     _select_args
330     _dbh_execute_array
331     _sql_maker_args
332     _sql_maker
333     _query_start
334     _sqlt_version_error
335     _per_row_update_delete
336     _dbh_begin_work
337     _dbh_execute_inserts_with_no_binds
338     _select_args_to_query
339     _svp_generate_name
340     _multipk_update_delete
341     source_bind_attributes
342     _normalize_connect_info
343     _parse_connect_do
344     _dbh_commit
345     _execute_array
346     _placeholders_supported
347     savepoints
348     _sqlt_minimum_version
349     _sql_maker_opts
350     _conn_pid
351     _typeless_placeholders_supported
352     _conn_tid
353     _dbh_autocommit
354     _native_data_type
355     _get_dbh
356     sql_maker_class
357     _dbh_rollback
358     _adjust_select_args_for_complex_prefetch
359     _resolve_ident_sources
360     _resolve_column_info
361     _prune_unused_joins
362     _strip_cond_qualifiers
363     _parse_order_by
364     _resolve_aliastypes_from_select_args
365     _execute
366     _do_query
367     _dbh_sth
368     _dbh_execute
369     _prefetch_insert_auto_nextvals
370     _server_info_hash
371   /],
372 );
373
374 my @unimplemented = qw(
375   _arm_global_destructor
376   _preserve_foreign_dbh
377   _verify_pid
378   _verify_tid
379 );
380
381 for my $method (@unimplemented) {
382   __PACKAGE__->meta->add_method($method, sub {
383     croak "$method must not be called on ".(blessed shift).' objects';
384   });
385 }
386
387 has _master_connect_info_opts =>
388   (is => 'rw', isa => HashRef, default => sub { {} });
389
390 =head2 around: connect_info
391
392 Preserves master's C<connect_info> options (for merging with replicants.)
393 Also sets any Replicated-related options from connect_info, such as
394 C<pool_type>, C<pool_args>, C<balancer_type> and C<balancer_args>.
395
396 =cut
397
398 around connect_info => sub {
399   my ($next, $self, $info, @extra) = @_;
400
401   my $wantarray = wantarray;
402
403   my $merge = Hash::Merge->new('LEFT_PRECEDENT');
404
405   my %opts;
406   for my $arg (@$info) {
407     next unless (reftype($arg)||'') eq 'HASH';
408     %opts = %{ $merge->merge($arg, \%opts) };
409   }
410   delete $opts{dsn};
411
412   if (@opts{qw/pool_type pool_args/}) {
413     $self->pool_type(delete $opts{pool_type})
414       if $opts{pool_type};
415
416     $self->pool_args(
417       $merge->merge((delete $opts{pool_args} || {}), $self->pool_args)
418     );
419
420     $self->pool($self->_build_pool)
421       if $self->pool;
422   }
423
424   if (@opts{qw/balancer_type balancer_args/}) {
425     $self->balancer_type(delete $opts{balancer_type})
426       if $opts{balancer_type};
427
428     $self->balancer_args(
429       $merge->merge((delete $opts{balancer_args} || {}), $self->balancer_args)
430     );
431
432     $self->balancer($self->_build_balancer)
433       if $self->balancer;
434   }
435
436   $self->_master_connect_info_opts(\%opts);
437
438   my (@res, $res);
439   if ($wantarray) {
440     @res = $self->$next($info, @extra);
441   } else {
442     $res = $self->$next($info, @extra);
443   }
444
445   # Make sure master is blessed into the correct class and apply role to it.
446   my $master = $self->master;
447   $master->_determine_driver;
448   Moose::Meta::Class->initialize(ref $master);
449
450   DBIx::Class::Storage::DBI::Replicated::WithDSN->meta->apply($master);
451
452   # link pool back to master
453   $self->pool->master($master);
454
455   $wantarray ? @res : $res;
456 };
457
458 =head1 METHODS
459
460 This class defines the following methods.
461
462 =head2 BUILDARGS
463
464 L<DBIx::Class::Schema> when instantiating its storage passed itself as the
465 first argument.  So we need to massage the arguments a bit so that all the
466 bits get put into the correct places.
467
468 =cut
469
470 sub BUILDARGS {
471   my ($class, $schema, $storage_type_args, @args) = @_;
472
473   return {
474     schema=>$schema,
475     %$storage_type_args,
476     @args
477   }
478 }
479
480 =head2 _build_master
481
482 Lazy builder for the L</master> attribute.
483
484 =cut
485
486 sub _build_master {
487   my $self = shift @_;
488   my $master = DBIx::Class::Storage::DBI->new($self->schema);
489   $master
490 }
491
492 =head2 _build_pool
493
494 Lazy builder for the L</pool> attribute.
495
496 =cut
497
498 sub _build_pool {
499   my $self = shift @_;
500   $self->create_pool(%{$self->pool_args});
501 }
502
503 =head2 _build_balancer
504
505 Lazy builder for the L</balancer> attribute.  This takes a Pool object so that
506 the balancer knows which pool it's balancing.
507
508 =cut
509
510 sub _build_balancer {
511   my $self = shift @_;
512   $self->create_balancer(
513     pool=>$self->pool,
514     master=>$self->master,
515     %{$self->balancer_args},
516   );
517 }
518
519 =head2 _build_write_handler
520
521 Lazy builder for the L</write_handler> attribute.  The default is to set this to
522 the L</master>.
523
524 =cut
525
526 sub _build_write_handler {
527   return shift->master;
528 }
529
530 =head2 _build_read_handler
531
532 Lazy builder for the L</read_handler> attribute.  The default is to set this to
533 the L</balancer>.
534
535 =cut
536
537 sub _build_read_handler {
538   return shift->balancer;
539 }
540
541 =head2 around: connect_replicants
542
543 All calls to connect_replicants needs to have an existing $schema tacked onto
544 top of the args, since L<DBIx::Storage::DBI> needs it, and any C<connect_info>
545 options merged with the master, with replicant opts having higher priority.
546
547 =cut
548
549 around connect_replicants => sub {
550   my ($next, $self, @args) = @_;
551
552   for my $r (@args) {
553     $r = [ $r ] unless reftype $r eq 'ARRAY';
554
555     $self->throw_exception('coderef replicant connect_info not supported')
556       if ref $r->[0] && reftype $r->[0] eq 'CODE';
557
558 # any connect_info options?
559     my $i = 0;
560     $i++ while $i < @$r && (reftype($r->[$i])||'') ne 'HASH';
561
562 # make one if none
563     $r->[$i] = {} unless $r->[$i];
564
565 # merge if two hashes
566     my @hashes = @$r[$i .. $#{$r}];
567
568     $self->throw_exception('invalid connect_info options')
569       if (grep { reftype($_) eq 'HASH' } @hashes) != @hashes;
570
571     $self->throw_exception('too many hashrefs in connect_info')
572       if @hashes > 2;
573
574     my $merge = Hash::Merge->new('LEFT_PRECEDENT');
575     my %opts = %{ $merge->merge(reverse @hashes) };
576
577 # delete them
578     splice @$r, $i+1, ($#{$r} - $i), ();
579
580 # make sure master/replicants opts don't clash
581     my %master_opts = %{ $self->_master_connect_info_opts };
582     if (exists $opts{dbh_maker}) {
583         delete @master_opts{qw/dsn user password/};
584     }
585     delete $master_opts{dbh_maker};
586
587 # merge with master
588     %opts = %{ $merge->merge(\%opts, \%master_opts) };
589
590 # update
591     $r->[$i] = \%opts;
592   }
593
594   $self->$next($self->schema, @args);
595 };
596
597 =head2 all_storages
598
599 Returns an array of of all the connected storage backends.  The first element
600 in the returned array is the master, and the remainings are each of the
601 replicants.
602
603 =cut
604
605 sub all_storages {
606   my $self = shift @_;
607   return grep {defined $_ && blessed $_} (
608      $self->master,
609      values %{ $self->replicants },
610   );
611 }
612
613 =head2 execute_reliably ($coderef, ?@args)
614
615 Given a coderef, saves the current state of the L</read_handler>, forces it to
616 use reliable storage (e.g. sets it to the master), executes a coderef and then
617 restores the original state.
618
619 Example:
620
621   my $reliably = sub {
622     my $name = shift @_;
623     $schema->resultset('User')->create({name=>$name});
624     my $user_rs = $schema->resultset('User')->find({name=>$name});
625     return $user_rs;
626   };
627
628   my $user_rs = $schema->storage->execute_reliably($reliably, 'John');
629
630 Use this when you must be certain of your database state, such as when you just
631 inserted something and need to get a resultset including it, etc.
632
633 =cut
634
635 sub execute_reliably {
636   my ($self, $coderef, @args) = @_;
637
638   unless( ref $coderef eq 'CODE') {
639     $self->throw_exception('Second argument must be a coderef');
640   }
641
642   ##Get copy of master storage
643   my $master = $self->master;
644
645   ##Get whatever the current read hander is
646   my $current = $self->read_handler;
647
648   ##Set the read handler to master
649   $self->read_handler($master);
650
651   ## do whatever the caller needs
652   my @result;
653   my $want_array = wantarray;
654
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;