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