Commit | Line | Data |
2156bbdd |
1 | package DBIx::Class::Storage::DBI::Replicated; |
f5d3a5de |
2 | |
ecb65397 |
3 | BEGIN { |
4 | use Carp::Clan qw/^DBIx::Class/; |
a34b0c89 |
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'); |
ecb65397 |
8 | } |
9 | |
b2e4d522 |
10 | use Moose; |
26ab719a |
11 | use DBIx::Class::Storage::DBI; |
2bf79155 |
12 | use DBIx::Class::Storage::DBI::Replicated::Pool; |
26ab719a |
13 | use DBIx::Class::Storage::DBI::Replicated::Balancer; |
6a151f58 |
14 | use DBIx::Class::Storage::DBI::Replicated::Types qw/BalancerClassNamePart DBICSchema DBICStorageDBI/; |
41916570 |
15 | use MooseX::Types::Moose qw/ClassName HashRef Object/; |
b2e4d522 |
16 | use Scalar::Util 'reftype'; |
e666c5fd |
17 | use Hash::Merge; |
7da56142 |
18 | use List::Util qw/min max reduce/; |
9901aad7 |
19 | |
20 | use namespace::clean -except => 'meta'; |
2bf79155 |
21 | |
22 | =head1 NAME |
23 | |
ecb65397 |
24 | DBIx::Class::Storage::DBI::Replicated - BETA Replicated database support |
2bf79155 |
25 | |
26 | =head1 SYNOPSIS |
27 | |
28 | The Following example shows how to change an existing $schema to a replicated |
48580715 |
29 | storage type, add some replicated (read-only) databases, and perform reporting |
955a6df6 |
30 | tasks. |
2bf79155 |
31 | |
3da4f736 |
32 | You should set the 'storage_type attribute to a replicated type. You should |
d4daee7b |
33 | also define your arguments, such as which balancer you want and any arguments |
3da4f736 |
34 | that the Pool object should get. |
35 | |
ce854fd3 |
36 | my $schema = Schema::Class->clone; |
64cdad22 |
37 | $schema->storage_type( ['::DBI::Replicated', {balancer=>'::Random'}] ); |
ce854fd3 |
38 | $schema->connection(...); |
d4daee7b |
39 | |
3da4f736 |
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. |
d4daee7b |
43 | |
64cdad22 |
44 | $schema->storage->connect_replicants( |
45 | [$dsn1, $user, $pass, \%opts], |
46 | [$dsn2, $user, $pass, \%opts], |
47 | [$dsn3, $user, $pass, \%opts], |
48 | ); |
d4daee7b |
49 | |
3da4f736 |
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 | |
7e38d850 |
53 | $schema->resultset('Source')->search({name=>'etc'}); |
d4daee7b |
54 | |
3da4f736 |
55 | You can force a given query to use a particular storage using the search |
56 | attribute 'force_pool'. For example: |
d4daee7b |
57 | |
7e38d850 |
58 | my $RS = $schema->resultset('Source')->search(undef, {force_pool=>'master'}); |
3da4f736 |
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: |
212cc5c2 |
63 | L<DBIx::Class::Storage::DBI::Replicated::Pool> and the replicants attribute for more. |
3da4f736 |
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. |
212cc5c2 |
69 | |
70 | See L<DBIx::Class::Storage::DBI::Replicated::Instructions> for more help and |
71 | walkthroughs. |
d4daee7b |
72 | |
2bf79155 |
73 | =head1 DESCRIPTION |
74 | |
7e38d850 |
75 | Warning: This class is marked BETA. This has been running a production |
ccb3b897 |
76 | website using MySQL native replication as its backend and we have some decent |
7e38d850 |
77 | test coverage but the code hasn't yet been stressed by a variety of databases. |
48580715 |
78 | Individual DBs may have quirks we are not aware of. Please use this in first |
7e38d850 |
79 | development and pass along your experiences/bug fixes. |
2bf79155 |
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 |
bca099a3 |
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 |
2bf79155 |
89 | to all existing storages. This way our storage class is a drop in replacement |
90 | for L<DBIx::Class::Storage::DBI>. |
91 | |
48580715 |
92 | Read traffic is spread across the replicants (slaves) occurring to a user |
2bf79155 |
93 | selected algorithm. The default algorithm is random weighted. |
94 | |
bca099a3 |
95 | =head1 NOTES |
96 | |
48580715 |
97 | The consistency between master and replicants is database specific. The Pool |
faaba25f |
98 | gives you a method to validate its replicants, removing and replacing them |
7e38d850 |
99 | when they fail/pass predefined criteria. Please make careful use of the ways |
ecb65397 |
100 | to force a query to run against Master when needed. |
101 | |
102 | =head1 REQUIREMENTS |
103 | |
a34b0c89 |
104 | Replicated Storage has additional requirements not currently part of |
aa8b2277 |
105 | L<DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details. |
2bf79155 |
106 | |
107 | =head1 ATTRIBUTES |
108 | |
109 | This class defines the following attributes. |
110 | |
2ce6e9a6 |
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', |
6a151f58 |
119 | isa=>DBICSchema, |
2ce6e9a6 |
120 | weak_ref=>1, |
121 | required=>1, |
122 | ); |
123 | |
26ab719a |
124 | =head2 pool_type |
2bf79155 |
125 | |
26ab719a |
126 | Contains the classname which will instantiate the L</pool> object. Defaults |
127 | to: L<DBIx::Class::Storage::DBI::Replicated::Pool>. |
2bf79155 |
128 | |
129 | =cut |
130 | |
26ab719a |
131 | has 'pool_type' => ( |
dcdf7b2c |
132 | is=>'rw', |
41916570 |
133 | isa=>ClassName, |
2ce6e9a6 |
134 | default=>'DBIx::Class::Storage::DBI::Replicated::Pool', |
64cdad22 |
135 | handles=>{ |
136 | 'create_pool' => 'new', |
137 | }, |
2bf79155 |
138 | ); |
139 | |
f068a139 |
140 | =head2 pool_args |
141 | |
142 | Contains a hashref of initialized information to pass to the Balancer object. |
212cc5c2 |
143 | See L<DBIx::Class::Storage::DBI::Replicated::Pool> for available arguments. |
f068a139 |
144 | |
145 | =cut |
146 | |
147 | has 'pool_args' => ( |
dcdf7b2c |
148 | is=>'rw', |
41916570 |
149 | isa=>HashRef, |
64cdad22 |
150 | lazy=>1, |
64cdad22 |
151 | default=>sub { {} }, |
f068a139 |
152 | ); |
153 | |
154 | |
26ab719a |
155 | =head2 balancer_type |
2bf79155 |
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 | |
26ab719a |
162 | has 'balancer_type' => ( |
dcdf7b2c |
163 | is=>'rw', |
9901aad7 |
164 | isa=>BalancerClassNamePart, |
2ce6e9a6 |
165 | coerce=>1, |
166 | required=>1, |
167 | default=> 'DBIx::Class::Storage::DBI::Replicated::Balancer::First', |
64cdad22 |
168 | handles=>{ |
169 | 'create_balancer' => 'new', |
170 | }, |
2bf79155 |
171 | ); |
172 | |
17b05c13 |
173 | =head2 balancer_args |
174 | |
175 | Contains a hashref of initialized information to pass to the Balancer object. |
212cc5c2 |
176 | See L<DBIx::Class::Storage::DBI::Replicated::Balancer> for available arguments. |
17b05c13 |
177 | |
178 | =cut |
179 | |
180 | has 'balancer_args' => ( |
dcdf7b2c |
181 | is=>'rw', |
41916570 |
182 | isa=>HashRef, |
64cdad22 |
183 | lazy=>1, |
184 | required=>1, |
185 | default=>sub { {} }, |
17b05c13 |
186 | ); |
187 | |
26ab719a |
188 | =head2 pool |
2bf79155 |
189 | |
26ab719a |
190 | Is a <DBIx::Class::Storage::DBI::Replicated::Pool> or derived class. This is a |
191 | container class for one or more replicated databases. |
2bf79155 |
192 | |
193 | =cut |
194 | |
26ab719a |
195 | has 'pool' => ( |
64cdad22 |
196 | is=>'ro', |
197 | isa=>'DBIx::Class::Storage::DBI::Replicated::Pool', |
198 | lazy_build=>1, |
199 | handles=>[qw/ |
6f7344b8 |
200 | connect_replicants |
64cdad22 |
201 | replicants |
202 | has_replicants |
203 | /], |
2bf79155 |
204 | ); |
205 | |
26ab719a |
206 | =head2 balancer |
2bf79155 |
207 | |
26ab719a |
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>) |
2bf79155 |
210 | |
26ab719a |
211 | =cut |
2bf79155 |
212 | |
26ab719a |
213 | has 'balancer' => ( |
dcdf7b2c |
214 | is=>'rw', |
64cdad22 |
215 | isa=>'DBIx::Class::Storage::DBI::Replicated::Balancer', |
216 | lazy_build=>1, |
217 | handles=>[qw/auto_validate_every/], |
26ab719a |
218 | ); |
2bf79155 |
219 | |
cb6ec758 |
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' => ( |
64cdad22 |
231 | is=> 'ro', |
6a151f58 |
232 | isa=>DBICStorageDBI, |
64cdad22 |
233 | lazy_build=>1, |
cb6ec758 |
234 | ); |
235 | |
cb6ec758 |
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' => ( |
64cdad22 |
248 | is=>'rw', |
41916570 |
249 | isa=>Object, |
64cdad22 |
250 | lazy_build=>1, |
251 | handles=>[qw/ |
252 | select |
253 | select_single |
254 | columns_info_for |
3244fdcc |
255 | _dbh_columns_info_for |
256 | _select |
6f7344b8 |
257 | /], |
cb6ec758 |
258 | ); |
259 | |
cb6ec758 |
260 | =head2 write_handler |
261 | |
3244fdcc |
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. |
cb6ec758 |
266 | |
267 | =cut |
268 | |
269 | has 'write_handler' => ( |
64cdad22 |
270 | is=>'ro', |
41916570 |
271 | isa=>Object, |
64cdad22 |
272 | lazy_build=>1, |
6f7344b8 |
273 | handles=>[qw/ |
64cdad22 |
274 | on_connect_do |
6f7344b8 |
275 | on_disconnect_do |
3244fdcc |
276 | on_connect_call |
277 | on_disconnect_call |
64cdad22 |
278 | connect_info |
3244fdcc |
279 | _connect_info |
64cdad22 |
280 | throw_exception |
281 | sql_maker |
282 | sqlt_type |
283 | create_ddl_dir |
284 | deployment_statements |
285 | datetime_parser |
6f7344b8 |
286 | datetime_parser_type |
287 | build_datetime_parser |
64cdad22 |
288 | last_insert_id |
289 | insert |
290 | insert_bulk |
291 | update |
292 | delete |
293 | dbh |
2ce6e9a6 |
294 | txn_begin |
64cdad22 |
295 | txn_do |
296 | txn_commit |
297 | txn_rollback |
2ce6e9a6 |
298 | txn_scope_guard |
64cdad22 |
299 | sth |
300 | deploy |
0180bef9 |
301 | with_deferred_fk_checks |
6f7344b8 |
302 | dbh_do |
64cdad22 |
303 | reload_row |
6f7344b8 |
304 | with_deferred_fk_checks |
2ce6e9a6 |
305 | _prep_for_execute |
7fb60fb1 |
306 | |
6f7344b8 |
307 | backup |
308 | is_datatype_numeric |
227d8366 |
309 | _supports_insert_returning |
6f7344b8 |
310 | _count_select |
311 | _subq_count_select |
312 | _subq_update_delete |
313 | svp_rollback |
314 | svp_begin |
315 | svp_release |
e398f77e |
316 | relname_to_table_alias |
317 | _straight_join_to_node |
3244fdcc |
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 |
3244fdcc |
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 |
6ed1cd2e |
368 | _prefetch_insert_auto_nextvals |
6d766626 |
369 | _server_info_hash |
64cdad22 |
370 | /], |
cb6ec758 |
371 | ); |
372 | |
e471ab87 |
373 | my @unimplemented = qw( |
374 | _arm_global_destructor |
375 | _preserve_foreign_dbh |
572338e0 |
376 | _verify_pid |
377 | _verify_tid |
e471ab87 |
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 | } |
6d766626 |
385 | |
b2e4d522 |
386 | has _master_connect_info_opts => |
387 | (is => 'rw', isa => HashRef, default => sub { {} }); |
388 | |
389 | =head2 around: connect_info |
390 | |
48580715 |
391 | Preserves master's C<connect_info> options (for merging with replicants.) |
392 | Also sets any Replicated-related options from connect_info, such as |
dcdf7b2c |
393 | C<pool_type>, C<pool_args>, C<balancer_type> and C<balancer_args>. |
b2e4d522 |
394 | |
395 | =cut |
396 | |
397 | around connect_info => sub { |
398 | my ($next, $self, $info, @extra) = @_; |
399 | |
0ce2d0d5 |
400 | my $wantarray = wantarray; |
401 | |
282a9a4f |
402 | my $merge = Hash::Merge->new('LEFT_PRECEDENT'); |
e666c5fd |
403 | |
b2e4d522 |
404 | my %opts; |
405 | for my $arg (@$info) { |
406 | next unless (reftype($arg)||'') eq 'HASH'; |
e666c5fd |
407 | %opts = %{ $merge->merge($arg, \%opts) }; |
b2e4d522 |
408 | } |
b2e4d522 |
409 | delete $opts{dsn}; |
410 | |
dcdf7b2c |
411 | if (@opts{qw/pool_type pool_args/}) { |
412 | $self->pool_type(delete $opts{pool_type}) |
413 | if $opts{pool_type}; |
414 | |
b88b85e7 |
415 | $self->pool_args( |
e666c5fd |
416 | $merge->merge((delete $opts{pool_args} || {}), $self->pool_args) |
b88b85e7 |
417 | ); |
dcdf7b2c |
418 | |
67c43863 |
419 | $self->pool($self->_build_pool) |
6f7344b8 |
420 | if $self->pool; |
dcdf7b2c |
421 | } |
422 | |
423 | if (@opts{qw/balancer_type balancer_args/}) { |
424 | $self->balancer_type(delete $opts{balancer_type}) |
425 | if $opts{balancer_type}; |
426 | |
b88b85e7 |
427 | $self->balancer_args( |
e666c5fd |
428 | $merge->merge((delete $opts{balancer_args} || {}), $self->balancer_args) |
b88b85e7 |
429 | ); |
dcdf7b2c |
430 | |
67c43863 |
431 | $self->balancer($self->_build_balancer) |
6f7344b8 |
432 | if $self->balancer; |
dcdf7b2c |
433 | } |
434 | |
b2e4d522 |
435 | $self->_master_connect_info_opts(\%opts); |
436 | |
0ce2d0d5 |
437 | my (@res, $res); |
438 | if ($wantarray) { |
439 | @res = $self->$next($info, @extra); |
440 | } else { |
441 | $res = $self->$next($info, @extra); |
442 | } |
443 | |
fd4eb9c2 |
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); |
cea43436 |
448 | |
ec0946db |
449 | DBIx::Class::Storage::DBI::Replicated::WithDSN->meta->apply($master); |
cea43436 |
450 | |
451 | # link pool back to master |
452 | $self->pool->master($master); |
0ce2d0d5 |
453 | |
454 | $wantarray ? @res : $res; |
b2e4d522 |
455 | }; |
456 | |
26ab719a |
457 | =head1 METHODS |
2bf79155 |
458 | |
26ab719a |
459 | This class defines the following methods. |
2bf79155 |
460 | |
c354902c |
461 | =head2 BUILDARGS |
2bf79155 |
462 | |
faaba25f |
463 | L<DBIx::Class::Schema> when instantiating its storage passed itself as the |
2ce6e9a6 |
464 | first argument. So we need to massage the arguments a bit so that all the |
465 | bits get put into the correct places. |
2bf79155 |
466 | |
467 | =cut |
468 | |
c354902c |
469 | sub BUILDARGS { |
d7a58a29 |
470 | my ($class, $schema, $storage_type_args, @args) = @_; |
d4daee7b |
471 | |
c354902c |
472 | return { |
6f7344b8 |
473 | schema=>$schema, |
474 | %$storage_type_args, |
475 | @args |
c354902c |
476 | } |
477 | } |
2bf79155 |
478 | |
cb6ec758 |
479 | =head2 _build_master |
2bf79155 |
480 | |
cb6ec758 |
481 | Lazy builder for the L</master> attribute. |
2bf79155 |
482 | |
483 | =cut |
484 | |
cb6ec758 |
485 | sub _build_master { |
2ce6e9a6 |
486 | my $self = shift @_; |
ee356d00 |
487 | my $master = DBIx::Class::Storage::DBI->new($self->schema); |
ee356d00 |
488 | $master |
106d5f3b |
489 | } |
490 | |
26ab719a |
491 | =head2 _build_pool |
2bf79155 |
492 | |
26ab719a |
493 | Lazy builder for the L</pool> attribute. |
2bf79155 |
494 | |
495 | =cut |
496 | |
26ab719a |
497 | sub _build_pool { |
64cdad22 |
498 | my $self = shift @_; |
499 | $self->create_pool(%{$self->pool_args}); |
2bf79155 |
500 | } |
501 | |
26ab719a |
502 | =head2 _build_balancer |
2bf79155 |
503 | |
cb6ec758 |
504 | Lazy builder for the L</balancer> attribute. This takes a Pool object so that |
505 | the balancer knows which pool it's balancing. |
2bf79155 |
506 | |
507 | =cut |
508 | |
26ab719a |
509 | sub _build_balancer { |
64cdad22 |
510 | my $self = shift @_; |
511 | $self->create_balancer( |
6f7344b8 |
512 | pool=>$self->pool, |
64cdad22 |
513 | master=>$self->master, |
514 | %{$self->balancer_args}, |
515 | ); |
2bf79155 |
516 | } |
517 | |
cb6ec758 |
518 | =head2 _build_write_handler |
2bf79155 |
519 | |
cb6ec758 |
520 | Lazy builder for the L</write_handler> attribute. The default is to set this to |
521 | the L</master>. |
50336325 |
522 | |
523 | =cut |
524 | |
cb6ec758 |
525 | sub _build_write_handler { |
64cdad22 |
526 | return shift->master; |
cb6ec758 |
527 | } |
50336325 |
528 | |
cb6ec758 |
529 | =head2 _build_read_handler |
2bf79155 |
530 | |
cb6ec758 |
531 | Lazy builder for the L</read_handler> attribute. The default is to set this to |
532 | the L</balancer>. |
2bf79155 |
533 | |
534 | =cut |
535 | |
cb6ec758 |
536 | sub _build_read_handler { |
64cdad22 |
537 | return shift->balancer; |
cb6ec758 |
538 | } |
50336325 |
539 | |
cb6ec758 |
540 | =head2 around: connect_replicants |
2bf79155 |
541 | |
cb6ec758 |
542 | All calls to connect_replicants needs to have an existing $schema tacked onto |
b2e4d522 |
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. |
955a6df6 |
545 | |
cb6ec758 |
546 | =cut |
955a6df6 |
547 | |
b2e4d522 |
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 | |
1a58752c |
554 | $self->throw_exception('coderef replicant connect_info not supported') |
b2e4d522 |
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 | |
6f7344b8 |
561 | # make one if none |
b2e4d522 |
562 | $r->[$i] = {} unless $r->[$i]; |
563 | |
564 | # merge if two hashes |
b88b85e7 |
565 | my @hashes = @$r[$i .. $#{$r}]; |
566 | |
1a58752c |
567 | $self->throw_exception('invalid connect_info options') |
b88b85e7 |
568 | if (grep { reftype($_) eq 'HASH' } @hashes) != @hashes; |
569 | |
1a58752c |
570 | $self->throw_exception('too many hashrefs in connect_info') |
b88b85e7 |
571 | if @hashes > 2; |
572 | |
282a9a4f |
573 | my $merge = Hash::Merge->new('LEFT_PRECEDENT'); |
e666c5fd |
574 | my %opts = %{ $merge->merge(reverse @hashes) }; |
b88b85e7 |
575 | |
576 | # delete them |
b2e4d522 |
577 | splice @$r, $i+1, ($#{$r} - $i), (); |
578 | |
0bd8e058 |
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 | |
b2e4d522 |
586 | # merge with master |
e666c5fd |
587 | %opts = %{ $merge->merge(\%opts, \%master_opts) }; |
b2e4d522 |
588 | |
589 | # update |
590 | $r->[$i] = \%opts; |
591 | } |
592 | |
593 | $self->$next($self->schema, @args); |
955a6df6 |
594 | }; |
2bf79155 |
595 | |
2bf79155 |
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 { |
64cdad22 |
605 | my $self = shift @_; |
606 | return grep {defined $_ && blessed $_} ( |
607 | $self->master, |
6412a592 |
608 | values %{ $self->replicants }, |
64cdad22 |
609 | ); |
2bf79155 |
610 | } |
611 | |
c4d3fae2 |
612 | =head2 execute_reliably ($coderef, ?@args) |
613 | |
614 | Given a coderef, saves the current state of the L</read_handler>, forces it to |
48580715 |
615 | use reliable storage (e.g. sets it to the master), executes a coderef and then |
c4d3fae2 |
616 | restores the original state. |
617 | |
618 | Example: |
619 | |
64cdad22 |
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 | }; |
c4d3fae2 |
626 | |
64cdad22 |
627 | my $user_rs = $schema->storage->execute_reliably($reliably, 'John'); |
c4d3fae2 |
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 { |
64cdad22 |
635 | my ($self, $coderef, @args) = @_; |
d4daee7b |
636 | |
64cdad22 |
637 | unless( ref $coderef eq 'CODE') { |
638 | $self->throw_exception('Second argument must be a coderef'); |
639 | } |
d4daee7b |
640 | |
64cdad22 |
641 | ##Get copy of master storage |
642 | my $master = $self->master; |
d4daee7b |
643 | |
64cdad22 |
644 | ##Get whatever the current read hander is |
645 | my $current = $self->read_handler; |
d4daee7b |
646 | |
64cdad22 |
647 | ##Set the read handler to master |
648 | $self->read_handler($master); |
d4daee7b |
649 | |
64cdad22 |
650 | ## do whatever the caller needs |
651 | my @result; |
652 | my $want_array = wantarray; |
d4daee7b |
653 | |
64cdad22 |
654 | eval { |
655 | if($want_array) { |
656 | @result = $coderef->(@args); |
657 | } elsif(defined $want_array) { |
658 | ($result[0]) = ($coderef->(@args)); |
ed213e85 |
659 | } else { |
64cdad22 |
660 | $coderef->(@args); |
6f7344b8 |
661 | } |
64cdad22 |
662 | }; |
d4daee7b |
663 | |
64cdad22 |
664 | ##Reset to the original state |
6f7344b8 |
665 | $self->read_handler($current); |
d4daee7b |
666 | |
64cdad22 |
667 | ##Exception testing has to come last, otherwise you might leave the |
668 | ##read_handler set to master. |
d4daee7b |
669 | |
64cdad22 |
670 | if($@) { |
671 | $self->throw_exception("coderef returned an error: $@"); |
672 | } else { |
673 | return $want_array ? @result : $result[0]; |
674 | } |
c4d3fae2 |
675 | } |
676 | |
cb6ec758 |
677 | =head2 set_reliable_storage |
678 | |
679 | Sets the current $schema to be 'reliable', that is all queries, both read and |
680 | write are sent to the master |
d4daee7b |
681 | |
cb6ec758 |
682 | =cut |
683 | |
684 | sub set_reliable_storage { |
64cdad22 |
685 | my $self = shift @_; |
686 | my $schema = $self->schema; |
687 | my $write_handler = $self->schema->storage->write_handler; |
d4daee7b |
688 | |
64cdad22 |
689 | $schema->storage->read_handler($write_handler); |
cb6ec758 |
690 | } |
691 | |
692 | =head2 set_balanced_storage |
693 | |
694 | Sets the current $schema to be use the </balancer> for all reads, while all |
48580715 |
695 | writes are sent to the master only |
d4daee7b |
696 | |
cb6ec758 |
697 | =cut |
698 | |
699 | sub set_balanced_storage { |
64cdad22 |
700 | my $self = shift @_; |
701 | my $schema = $self->schema; |
bd5da369 |
702 | my $balanced_handler = $self->schema->storage->balancer; |
d4daee7b |
703 | |
bd5da369 |
704 | $schema->storage->read_handler($balanced_handler); |
cb6ec758 |
705 | } |
2bf79155 |
706 | |
707 | =head2 connected |
708 | |
709 | Check that the master and at least one of the replicants is connected. |
710 | |
711 | =cut |
712 | |
713 | sub connected { |
64cdad22 |
714 | my $self = shift @_; |
715 | return |
716 | $self->master->connected && |
717 | $self->pool->connected_replicants; |
2bf79155 |
718 | } |
719 | |
2bf79155 |
720 | =head2 ensure_connected |
721 | |
722 | Make sure all the storages are connected. |
723 | |
724 | =cut |
725 | |
726 | sub ensure_connected { |
64cdad22 |
727 | my $self = shift @_; |
728 | foreach my $source ($self->all_storages) { |
729 | $source->ensure_connected(@_); |
730 | } |
2bf79155 |
731 | } |
732 | |
2bf79155 |
733 | =head2 limit_dialect |
734 | |
735 | Set the limit_dialect for all existing storages |
736 | |
737 | =cut |
738 | |
739 | sub limit_dialect { |
64cdad22 |
740 | my $self = shift @_; |
741 | foreach my $source ($self->all_storages) { |
742 | $source->limit_dialect(@_); |
743 | } |
3fbe08e3 |
744 | return $self->master->quote_char; |
2bf79155 |
745 | } |
746 | |
2bf79155 |
747 | =head2 quote_char |
748 | |
749 | Set the quote_char for all existing storages |
750 | |
751 | =cut |
752 | |
753 | sub quote_char { |
64cdad22 |
754 | my $self = shift @_; |
755 | foreach my $source ($self->all_storages) { |
756 | $source->quote_char(@_); |
757 | } |
3fbe08e3 |
758 | return $self->master->quote_char; |
2bf79155 |
759 | } |
760 | |
2bf79155 |
761 | =head2 name_sep |
762 | |
763 | Set the name_sep for all existing storages |
764 | |
765 | =cut |
766 | |
767 | sub name_sep { |
64cdad22 |
768 | my $self = shift @_; |
769 | foreach my $source ($self->all_storages) { |
770 | $source->name_sep(@_); |
771 | } |
3fbe08e3 |
772 | return $self->master->name_sep; |
2bf79155 |
773 | } |
774 | |
2bf79155 |
775 | =head2 set_schema |
776 | |
777 | Set the schema object for all existing storages |
778 | |
779 | =cut |
780 | |
781 | sub set_schema { |
64cdad22 |
782 | my $self = shift @_; |
783 | foreach my $source ($self->all_storages) { |
784 | $source->set_schema(@_); |
785 | } |
2bf79155 |
786 | } |
787 | |
2bf79155 |
788 | =head2 debug |
789 | |
790 | set a debug flag across all storages |
791 | |
792 | =cut |
793 | |
794 | sub debug { |
64cdad22 |
795 | my $self = shift @_; |
3fbe08e3 |
796 | if(@_) { |
797 | foreach my $source ($self->all_storages) { |
798 | $source->debug(@_); |
6f7344b8 |
799 | } |
64cdad22 |
800 | } |
3fbe08e3 |
801 | return $self->master->debug; |
2bf79155 |
802 | } |
803 | |
2bf79155 |
804 | =head2 debugobj |
805 | |
cea43436 |
806 | set a debug object |
2bf79155 |
807 | |
808 | =cut |
809 | |
810 | sub debugobj { |
64cdad22 |
811 | my $self = shift @_; |
cea43436 |
812 | return $self->master->debugobj(@_); |
2bf79155 |
813 | } |
814 | |
2bf79155 |
815 | =head2 debugfh |
816 | |
cea43436 |
817 | set a debugfh object |
2bf79155 |
818 | |
819 | =cut |
820 | |
821 | sub debugfh { |
64cdad22 |
822 | my $self = shift @_; |
cea43436 |
823 | return $self->master->debugfh(@_); |
2bf79155 |
824 | } |
825 | |
2bf79155 |
826 | =head2 debugcb |
827 | |
cea43436 |
828 | set a debug callback |
2bf79155 |
829 | |
830 | =cut |
831 | |
832 | sub debugcb { |
64cdad22 |
833 | my $self = shift @_; |
cea43436 |
834 | return $self->master->debugcb(@_); |
2bf79155 |
835 | } |
836 | |
2bf79155 |
837 | =head2 disconnect |
838 | |
839 | disconnect everything |
840 | |
841 | =cut |
842 | |
843 | sub disconnect { |
64cdad22 |
844 | my $self = shift @_; |
845 | foreach my $source ($self->all_storages) { |
846 | $source->disconnect(@_); |
847 | } |
2bf79155 |
848 | } |
849 | |
b2e4d522 |
850 | =head2 cursor_class |
851 | |
852 | set cursor class on all storages, or return master's |
853 | |
854 | =cut |
855 | |
856 | sub cursor_class { |
857 | my ($self, $cursor_class) = @_; |
858 | |
859 | if ($cursor_class) { |
860 | $_->cursor_class($cursor_class) for $self->all_storages; |
861 | } |
862 | $self->master->cursor_class; |
863 | } |
d4daee7b |
864 | |
3244fdcc |
865 | =head2 cursor |
866 | |
867 | set cursor class on all storages, or return master's, alias for L</cursor_class> |
868 | above. |
869 | |
870 | =cut |
871 | |
872 | sub cursor { |
873 | my ($self, $cursor_class) = @_; |
874 | |
875 | if ($cursor_class) { |
876 | $_->cursor($cursor_class) for $self->all_storages; |
877 | } |
878 | $self->master->cursor; |
879 | } |
880 | |
881 | =head2 unsafe |
882 | |
883 | sets the L<DBIx::Class::Storage::DBI/unsafe> option on all storages or returns |
884 | master's current setting |
885 | |
886 | =cut |
887 | |
888 | sub unsafe { |
889 | my $self = shift; |
890 | |
891 | if (@_) { |
892 | $_->unsafe(@_) for $self->all_storages; |
893 | } |
894 | |
895 | return $self->master->unsafe; |
896 | } |
897 | |
898 | =head2 disable_sth_caching |
899 | |
900 | sets the L<DBIx::Class::Storage::DBI/disable_sth_caching> option on all storages |
901 | or returns master's current setting |
902 | |
903 | =cut |
904 | |
905 | sub disable_sth_caching { |
906 | my $self = shift; |
907 | |
908 | if (@_) { |
909 | $_->disable_sth_caching(@_) for $self->all_storages; |
910 | } |
911 | |
912 | return $self->master->disable_sth_caching; |
913 | } |
914 | |
915 | =head2 lag_behind_master |
916 | |
917 | returns the highest Replicant L<DBIx::Class::Storage::DBI/lag_behind_master> |
918 | setting |
919 | |
920 | =cut |
921 | |
922 | sub lag_behind_master { |
923 | my $self = shift; |
924 | |
925 | return max map $_->lag_behind_master, $self->replicants; |
926 | } |
927 | |
928 | =head2 is_replicating |
929 | |
930 | returns true if all replicants return true for |
931 | L<DBIx::Class::Storage::DBI/is_replicating> |
932 | |
933 | =cut |
934 | |
935 | sub is_replicating { |
936 | my $self = shift; |
937 | |
938 | return (grep $_->is_replicating, $self->replicants) == ($self->replicants); |
939 | } |
940 | |
941 | =head2 connect_call_datetime_setup |
942 | |
943 | calls L<DBIx::Class::Storage::DBI/connect_call_datetime_setup> for all storages |
944 | |
945 | =cut |
946 | |
947 | sub connect_call_datetime_setup { |
948 | my $self = shift; |
949 | $_->connect_call_datetime_setup for $self->all_storages; |
950 | } |
951 | |
952 | sub _populate_dbh { |
953 | my $self = shift; |
954 | $_->_populate_dbh for $self->all_storages; |
955 | } |
956 | |
957 | sub _connect { |
958 | my $self = shift; |
959 | $_->_connect for $self->all_storages; |
960 | } |
961 | |
962 | sub _rebless { |
963 | my $self = shift; |
964 | $_->_rebless for $self->all_storages; |
965 | } |
966 | |
967 | sub _determine_driver { |
968 | my $self = shift; |
969 | $_->_determine_driver for $self->all_storages; |
970 | } |
971 | |
972 | sub _driver_determined { |
973 | my $self = shift; |
974 | |
975 | if (@_) { |
976 | $_->_driver_determined(@_) for $self->all_storages; |
977 | } |
978 | |
979 | return $self->master->_driver_determined; |
980 | } |
981 | |
982 | sub _init { |
983 | my $self = shift; |
984 | |
985 | $_->_init for $self->all_storages; |
986 | } |
987 | |
988 | sub _run_connection_actions { |
989 | my $self = shift; |
990 | |
991 | $_->_run_connection_actions for $self->all_storages; |
992 | } |
993 | |
994 | sub _do_connection_actions { |
995 | my $self = shift; |
996 | |
997 | if (@_) { |
998 | $_->_do_connection_actions(@_) for $self->all_storages; |
999 | } |
1000 | } |
1001 | |
1002 | sub connect_call_do_sql { |
1003 | my $self = shift; |
1004 | $_->connect_call_do_sql(@_) for $self->all_storages; |
1005 | } |
1006 | |
1007 | sub disconnect_call_do_sql { |
1008 | my $self = shift; |
1009 | $_->disconnect_call_do_sql(@_) for $self->all_storages; |
1010 | } |
1011 | |
1012 | sub _seems_connected { |
1013 | my $self = shift; |
1014 | |
1015 | return min map $_->_seems_connected, $self->all_storages; |
1016 | } |
1017 | |
1018 | sub _ping { |
1019 | my $self = shift; |
1020 | |
1021 | return min map $_->_ping, $self->all_storages; |
1022 | } |
1023 | |
7da56142 |
1024 | my $numify_ver = sub { |
1025 | my $ver = shift; |
1026 | my @numparts = split /\D+/, $ver; |
1027 | my $format = '%d.' . (join '', ('%05d') x (@numparts - 1)); |
1028 | |
1029 | return sprintf $format, @numparts; |
1030 | }; |
1031 | |
fecb38cb |
1032 | sub _server_info { |
1033 | my $self = shift; |
1034 | |
1035 | if (not $self->_server_info_hash) { |
7da56142 |
1036 | my $min_version_info = ( |
1037 | reduce { $a->[0] < $b->[0] ? $a : $b } |
1038 | map [ $numify_ver->($_->{dbms_version}), $_ ], |
1039 | map $_->_server_info, $self->all_storages |
1040 | )->[1]; |
fecb38cb |
1041 | |
1042 | $self->_server_info_hash($min_version_info); # on master |
1043 | } |
1044 | |
1045 | return $self->_server_info_hash; |
1046 | } |
1047 | |
1048 | sub _get_server_version { |
1049 | my $self = shift; |
1050 | |
1051 | return $self->_server_info->{dbms_version}; |
1052 | } |
1053 | |
7e38d850 |
1054 | =head1 GOTCHAS |
1055 | |
1056 | Due to the fact that replicants can lag behind a master, you must take care to |
1057 | make sure you use one of the methods to force read queries to a master should |
1058 | you need realtime data integrity. For example, if you insert a row, and then |
1059 | immediately re-read it from the database (say, by doing $row->discard_changes) |
1060 | or you insert a row and then immediately build a query that expects that row |
1061 | to be an item, you should force the master to handle reads. Otherwise, due to |
1062 | the lag, there is no certainty your data will be in the expected state. |
1063 | |
1064 | For data integrity, all transactions automatically use the master storage for |
1065 | all read and write queries. Using a transaction is the preferred and recommended |
1066 | method to force the master to handle all read queries. |
1067 | |
1068 | Otherwise, you can force a single query to use the master with the 'force_pool' |
1069 | attribute: |
1070 | |
1071 | my $row = $resultset->search(undef, {force_pool=>'master'})->find($pk); |
1072 | |
1073 | This attribute will safely be ignore by non replicated storages, so you can use |
1074 | the same code for both types of systems. |
1075 | |
1076 | Lastly, you can use the L</execute_reliably> method, which works very much like |
1077 | a transaction. |
1078 | |
1079 | For debugging, you can turn replication on/off with the methods L</set_reliable_storage> |
1080 | and L</set_balanced_storage>, however this operates at a global level and is not |
1081 | suitable if you have a shared Schema object being used by multiple processes, |
1082 | such as on a web application server. You can get around this limitation by |
1083 | using the Schema clone method. |
1084 | |
1085 | my $new_schema = $schema->clone; |
1086 | $new_schema->set_reliable_storage; |
d4daee7b |
1087 | |
7e38d850 |
1088 | ## $new_schema will use only the Master storage for all reads/writes while |
1089 | ## the $schema object will use replicated storage. |
1090 | |
f5d3a5de |
1091 | =head1 AUTHOR |
1092 | |
64cdad22 |
1093 | John Napiorkowski <john.napiorkowski@takkle.com> |
f5d3a5de |
1094 | |
c4d3fae2 |
1095 | Based on code originated by: |
f5d3a5de |
1096 | |
64cdad22 |
1097 | Norbert Csongrádi <bert@cpan.org> |
1098 | Peter Siklósi <einon@einon.hu> |
2156bbdd |
1099 | |
f5d3a5de |
1100 | =head1 LICENSE |
1101 | |
1102 | You may distribute this code under the same terms as Perl itself. |
1103 | |
1104 | =cut |
1105 | |
c354902c |
1106 | __PACKAGE__->meta->make_immutable; |
1107 | |
f5d3a5de |
1108 | 1; |