Merge 'trunk' into 'sqla_1.50_compat'
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / Storage / DBI / Replicated / Pool.pm
1 package DBIx::Class::Storage::DBI::Replicated::Pool;
2
3 use Moose;
4 use MooseX::AttributeHelpers;
5 use DBIx::Class::Storage::DBI::Replicated::Replicant;
6 use List::Util qw(sum);
7
8 =head1 NAME
9
10 DBIx::Class::Storage::DBI::Replicated::Pool - Manage a pool of replicants
11
12 =head1 SYNOPSIS
13
14 This class is used internally by L<DBIx::Class::Storage::DBI::Replicated>.  You
15 shouldn't need to create instances of this class.
16   
17 =head1 DESCRIPTION
18
19 In a replicated storage type, there is at least one replicant to handle the
20 read only traffic.  The Pool class manages this replicant, or list of 
21 replicants, and gives some methods for querying information about their status.
22
23 =head1 ATTRIBUTES
24
25 This class defines the following attributes.
26
27 =head2 maximum_lag ($num)
28
29 This is a number which defines the maximum allowed lag returned by the
30 L<DBIx::Class::Storage::DBI/lag_behind_master> method.  The default is 0.  In
31 general, this should return a larger number when the replicant is lagging
32 behind it's master, however the implementation of this is database specific, so
33 don't count on this number having a fixed meaning.  For example, MySQL will
34 return a number of seconds that the replicating database is lagging.
35
36 =cut
37
38 has 'maximum_lag' => (
39   is=>'rw',
40   isa=>'Num',
41   required=>1,
42   lazy=>1,
43   default=>0,
44 );
45
46 =head2 last_validated
47
48 This is an integer representing a time since the last time the replicants were
49 validated. It's nothing fancy, just an integer provided via the perl time 
50 builtin.
51
52 =cut
53
54 has 'last_validated' => (
55   is=>'rw',
56   isa=>'Int',
57   reader=>'last_validated',
58   writer=>'_last_validated',
59   lazy=>1,
60   default=>0,
61 );
62
63 =head2 replicant_type ($classname)
64
65 Base class used to instantiate replicants that are in the pool.  Unless you
66 need to subclass L<DBIx::Class::Storage::DBI::Replicated::Replicant> you should
67 just leave this alone.
68
69 =cut
70
71 has 'replicant_type' => (
72   is=>'ro',
73   isa=>'ClassName',
74   required=>1,
75   default=>'DBIx::Class::Storage::DBI',
76   handles=>{
77     'create_replicant' => 'new',
78   },  
79 );
80
81 =head2 replicants
82
83 A hashref of replicant, with the key being the dsn and the value returning the
84 actual replicant storage.  For example if the $dsn element is something like:
85
86   "dbi:SQLite:dbname=dbfile"
87   
88 You could access the specific replicant via:
89
90   $schema->storage->replicants->{'dbname=dbfile'}
91   
92 This attributes also supports the following helper methods:
93
94 =over 4
95
96 =item set_replicant($key=>$storage)
97
98 Pushes a replicant onto the HashRef under $key
99
100 =item get_replicant($key)
101
102 Retrieves the named replicant
103
104 =item has_replicants
105
106 Returns true if the Pool defines replicants.
107
108 =item num_replicants
109
110 The number of replicants in the pool
111
112 =item delete_replicant ($key)
113
114 removes the replicant under $key from the pool
115
116 =back
117
118 =cut
119
120 has 'replicants' => (
121   is=>'rw',
122   metaclass => 'Collection::Hash',
123   isa=>'HashRef[DBIx::Class::Storage::DBI]',
124   default=>sub {{}},
125   provides  => {
126     'set' => 'set_replicant',
127     'get' => 'get_replicant',            
128     'empty' => 'has_replicants',
129     'count' => 'num_replicants',
130     'delete' => 'delete_replicant',
131   },
132 );
133
134 =head1 METHODS
135
136 This class defines the following methods.
137
138 =head2 connect_replicants ($schema, Array[$connect_info])
139
140 Given an array of $dsn suitable for connected to a database, create an
141 L<DBIx::Class::Storage::DBI::Replicated::Replicant> object and store it in the
142 L</replicants> attribute.
143
144 =cut
145
146 sub connect_replicants {
147   my $self = shift @_;
148   my $schema = shift @_;
149   
150   my @newly_created = ();
151   foreach my $connect_info (@_) {
152     my $replicant = $self->connect_replicant($schema, $connect_info);
153     my ($key) = ($connect_info->[0]=~m/^dbi\:.+\:(.+)$/);
154     $self->set_replicant( $key => $replicant);  
155     push @newly_created, $replicant;
156   }
157   
158   return @newly_created;
159 }
160
161 =head2 connect_replicant ($schema, $connect_info)
162
163 Given a schema object and a hashref of $connect_info, connect the replicant
164 and return it.
165
166 =cut
167
168 sub connect_replicant {
169   my ($self, $schema, $connect_info) = @_;
170   my $replicant = $self->create_replicant($schema);
171   $replicant->connect_info($connect_info);
172   $self->_safely_ensure_connected($replicant);
173   DBIx::Class::Storage::DBI::Replicated::Replicant->meta->apply($replicant);  
174   return $replicant;
175 }
176
177 =head2 _safely_ensure_connected ($replicant)
178
179 The standard ensure_connected method with throw an exception should it fail to
180 connect.  For the master database this is desirable, but since replicants are
181 allowed to fail, this behavior is not desirable.  This method wraps the call
182 to ensure_connected in an eval in order to catch any generated errors.  That
183 way a slave to go completely offline (ie, the box itself can die) without
184 bringing down your entire pool of databases.
185
186 =cut
187
188 sub _safely_ensure_connected {
189   my ($self, $replicant, @args) = @_;
190   my $return; eval {
191     $return = $replicant->ensure_connected(@args);
192   }; if ($@) {
193     $replicant
194         ->debugobj
195         ->print(
196             sprintf( "Exception trying to ->ensure_connected for replicant %s, error is %s",
197                 $self->_dbi_connect_info->[0], $@)
198         );
199   }
200   return $return;
201 }
202
203 =head2 connected_replicants
204
205 Returns true if there are connected replicants.  Actually is overloaded to
206 return the number of replicants.  So you can do stuff like:
207
208   if( my $num_connected = $storage->has_connected_replicants ) {
209     print "I have $num_connected connected replicants";
210   } else {
211     print "Sorry, no replicants.";
212   }
213
214 This method will actually test that each replicant in the L</replicants> hashref
215 is actually connected, try not to hit this 10 times a second.
216
217 =cut
218
219 sub connected_replicants {
220   my $self = shift @_;
221   return sum( map {
222     $_->connected ? 1:0
223   } $self->all_replicants );
224 }
225
226 =head2 active_replicants
227
228 This is an array of replicants that are considered to be active in the pool.
229 This does not check to see if they are connected, but if they are not, DBIC
230 should automatically reconnect them for us when we hit them with a query.
231
232 =cut
233
234 sub active_replicants {
235   my $self = shift @_;
236   return ( grep {$_} map {
237     $_->active ? $_:0
238   } $self->all_replicants );
239 }
240
241 =head2 all_replicants
242
243 Just a simple array of all the replicant storages.  No particular order to the
244 array is given, nor should any meaning be derived.
245
246 =cut
247
248 sub all_replicants {
249   my $self = shift @_;
250   return values %{$self->replicants};
251 }
252
253 =head2 validate_replicants
254
255 This does a check to see if 1) each replicate is connected (or reconnectable),
256 2) that is ->is_replicating, and 3) that it is not exceeding the lag amount
257 defined by L</maximum_lag>.  Replicants that fail any of these tests are set to
258 inactive, and thus removed from the replication pool.
259
260 This tests L<all_replicants>, since a replicant that has been previous marked
261 as inactive can be reactived should it start to pass the validation tests again.
262
263 See L<DBIx::Class::Storage::DBI> for more about checking if a replicating
264 connection is not following a master or is lagging.
265
266 Calling this method will generate queries on the replicant databases so it is
267 not recommended that you run them very often.
268
269 This method requires that your underlying storage engine supports some sort of
270 native replication mechanism.  Currently only MySQL native replication is
271 supported.  Your patches to make other replication types work are welcomed.
272
273 =cut
274
275 sub validate_replicants {
276   my $self = shift @_;
277   foreach my $replicant($self->all_replicants) {
278     if($self->_safely_ensure_connected($replicant)) {
279       my $is_replicating = $replicant->is_replicating;
280       unless(defined $is_replicating) {
281         $replicant->debugobj->print("Storage Driver ".ref $self." Does not support the 'is_replicating' method.  Assuming you are manually managing.");
282         next;
283       } else {
284         if($is_replicating) {
285           my $lag_behind_master = $replicant->lag_behind_master;
286           unless(defined $lag_behind_master) {
287             $replicant->debugobj->print("Storage Driver ".ref $self." Does not support the 'lag_behind_master' method.  Assuming you are manually managing.");
288             next;
289           } else {
290             if($lag_behind_master <= $self->maximum_lag) {
291               $replicant->active(1);
292             } else {
293               $replicant->active(0);  
294             }
295           }    
296         } else {
297           $replicant->active(0);
298         }
299       }
300     } else {
301       $replicant->active(0);
302     }
303   }
304   ## Mark that we completed this validation.  
305   $self->_last_validated(time);  
306 }
307
308 =head1 AUTHOR
309
310 John Napiorkowski <john.napiorkowski@takkle.com>
311
312 =head1 LICENSE
313
314 You may distribute this code under the same terms as Perl itself.
315
316 =cut
317
318 __PACKAGE__->meta->make_immutable;
319
320 1;