set version for dev users
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / Replicated.pm
CommitLineData
2156bbdd 1package DBIx::Class::Storage::DBI::Replicated;
f5d3a5de 2
ecb65397 3BEGIN {
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 10use Moose;
26ab719a 11use DBIx::Class::Storage::DBI;
2bf79155 12use DBIx::Class::Storage::DBI::Replicated::Pool;
26ab719a 13use DBIx::Class::Storage::DBI::Replicated::Balancer;
6a151f58 14use DBIx::Class::Storage::DBI::Replicated::Types qw/BalancerClassNamePart DBICSchema DBICStorageDBI/;
41916570 15use MooseX::Types::Moose qw/ClassName HashRef Object/;
b2e4d522 16use Scalar::Util 'reftype';
e666c5fd 17use Hash::Merge;
3244fdcc 18use List::Util qw/min max/;
9901aad7 19
20use namespace::clean -except => 'meta';
2bf79155 21
22=head1 NAME
23
ecb65397 24DBIx::Class::Storage::DBI::Replicated - BETA Replicated database support
2bf79155 25
26=head1 SYNOPSIS
27
28The Following example shows how to change an existing $schema to a replicated
48580715 29storage type, add some replicated (read-only) databases, and perform reporting
955a6df6 30tasks.
2bf79155 31
3da4f736 32You should set the 'storage_type attribute to a replicated type. You should
d4daee7b 33also define your arguments, such as which balancer you want and any arguments
3da4f736 34that 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 40Next, you need to add in the Replicants. Basically this is an array of
41arrayrefs, where each arrayref is database connect information. Think of these
42arguments 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 50Now, just use the $schema as you normally would. Automatically all reads will
51be delegated to the replicants, while writes to the master.
52
7e38d850 53 $schema->resultset('Source')->search({name=>'etc'});
d4daee7b 54
3da4f736 55You can force a given query to use a particular storage using the search
56attribute 'force_pool'. For example:
d4daee7b 57
7e38d850 58 my $RS = $schema->resultset('Source')->search(undef, {force_pool=>'master'});
3da4f736 59
60Now $RS will force everything (both reads and writes) to use whatever was setup
61as the master storage. 'master' is hardcoded to always point to the Master,
62but you can also use any Replicant name. Please see:
212cc5c2 63L<DBIx::Class::Storage::DBI::Replicated::Pool> and the replicants attribute for more.
3da4f736 64
65Also see transactions and L</execute_reliably> for alternative ways to
66force read traffic to the master. In general, you should wrap your statements
67in a transaction when you are reading and writing to the same tables at the
68same time, since your replicants will often lag a bit behind the master.
212cc5c2 69
70See L<DBIx::Class::Storage::DBI::Replicated::Instructions> for more help and
71walkthroughs.
d4daee7b 72
2bf79155 73=head1 DESCRIPTION
74
7e38d850 75Warning: This class is marked BETA. This has been running a production
ccb3b897 76website using MySQL native replication as its backend and we have some decent
7e38d850 77test coverage but the code hasn't yet been stressed by a variety of databases.
48580715 78Individual DBs may have quirks we are not aware of. Please use this in first
7e38d850 79development and pass along your experiences/bug fixes.
2bf79155 80
81This class implements replicated data store for DBI. Currently you can define
82one master and numerous slave database connections. All write-type queries
83(INSERT, UPDATE, DELETE and even LAST_INSERT_ID) are routed to master
84database, all read-type queries (SELECTs) go to the slave database.
85
86Basically, any method request that L<DBIx::Class::Storage::DBI> would normally
bca099a3 87handle gets delegated to one of the two attributes: L</read_handler> or to
88L</write_handler>. Additionally, some methods need to be distributed
2bf79155 89to all existing storages. This way our storage class is a drop in replacement
90for L<DBIx::Class::Storage::DBI>.
91
48580715 92Read traffic is spread across the replicants (slaves) occurring to a user
2bf79155 93selected algorithm. The default algorithm is random weighted.
94
bca099a3 95=head1 NOTES
96
48580715 97The consistency between master and replicants is database specific. The Pool
faaba25f 98gives you a method to validate its replicants, removing and replacing them
7e38d850 99when they fail/pass predefined criteria. Please make careful use of the ways
ecb65397 100to force a query to run against Master when needed.
101
102=head1 REQUIREMENTS
103
a34b0c89 104Replicated Storage has additional requirements not currently part of
aa8b2277 105L<DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details.
2bf79155 106
107=head1 ATTRIBUTES
108
109This class defines the following attributes.
110
2ce6e9a6 111=head2 schema
112
113The underlying L<DBIx::Class::Schema> object this storage is attaching
114
115=cut
116
117has '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 126Contains the classname which will instantiate the L</pool> object. Defaults
127to: L<DBIx::Class::Storage::DBI::Replicated::Pool>.
2bf79155 128
129=cut
130
26ab719a 131has '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
142Contains a hashref of initialized information to pass to the Balancer object.
212cc5c2 143See L<DBIx::Class::Storage::DBI::Replicated::Pool> for available arguments.
f068a139 144
145=cut
146
147has '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
157The replication pool requires a balance class to provider the methods for
158choose how to spread the query load across each replicant in the pool.
159
160=cut
161
26ab719a 162has '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
175Contains a hashref of initialized information to pass to the Balancer object.
212cc5c2 176See L<DBIx::Class::Storage::DBI::Replicated::Balancer> for available arguments.
17b05c13 177
178=cut
179
180has '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 190Is a <DBIx::Class::Storage::DBI::Replicated::Pool> or derived class. This is a
191container class for one or more replicated databases.
2bf79155 192
193=cut
194
26ab719a 195has '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 208Is a <DBIx::Class::Storage::DBI::Replicated::Balancer> or derived class. This
209is a class that takes a pool (<DBIx::Class::Storage::DBI::Replicated::Pool>)
2bf79155 210
26ab719a 211=cut
2bf79155 212
26ab719a 213has '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
222The master defines the canonical state for a pool of connected databases. All
223the replicants are expected to match this databases state. Thus, in a classic
224Master / Slaves distributed system, all the slaves are expected to replicate
225the Master's state as quick as possible. This is the only database in the
226pool of databases that is allowed to handle write traffic.
227
228=cut
229
230has '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
238The following methods are delegated all the methods required for the
239L<DBIx::Class::Storage::DBI> interface.
240
241=head2 read_handler
242
243Defines an object that implements the read side of L<BIx::Class::Storage::DBI>.
244
245=cut
246
247has '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 262Defines an object that implements the write side of L<BIx::Class::Storage::DBI>,
263as well as methods that don't write or read that can be called on only one
264storage, methods that return a C<$dbh>, and any methods that don't make sense to
265run on a replicant.
cb6ec758 266
267=cut
268
269has '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
346 _verify_pid
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
6ed1cd2e 369 _prefetch_insert_auto_nextvals
6d766626 370 _server_info_hash
64cdad22 371 /],
cb6ec758 372);
373
6d766626 374
b2e4d522 375has _master_connect_info_opts =>
376 (is => 'rw', isa => HashRef, default => sub { {} });
377
378=head2 around: connect_info
379
48580715 380Preserves master's C<connect_info> options (for merging with replicants.)
381Also sets any Replicated-related options from connect_info, such as
dcdf7b2c 382C<pool_type>, C<pool_args>, C<balancer_type> and C<balancer_args>.
b2e4d522 383
384=cut
385
386around connect_info => sub {
387 my ($next, $self, $info, @extra) = @_;
388
0ce2d0d5 389 my $wantarray = wantarray;
390
282a9a4f 391 my $merge = Hash::Merge->new('LEFT_PRECEDENT');
e666c5fd 392
b2e4d522 393 my %opts;
394 for my $arg (@$info) {
395 next unless (reftype($arg)||'') eq 'HASH';
e666c5fd 396 %opts = %{ $merge->merge($arg, \%opts) };
b2e4d522 397 }
b2e4d522 398 delete $opts{dsn};
399
dcdf7b2c 400 if (@opts{qw/pool_type pool_args/}) {
401 $self->pool_type(delete $opts{pool_type})
402 if $opts{pool_type};
403
b88b85e7 404 $self->pool_args(
e666c5fd 405 $merge->merge((delete $opts{pool_args} || {}), $self->pool_args)
b88b85e7 406 );
dcdf7b2c 407
67c43863 408 $self->pool($self->_build_pool)
6f7344b8 409 if $self->pool;
dcdf7b2c 410 }
411
412 if (@opts{qw/balancer_type balancer_args/}) {
413 $self->balancer_type(delete $opts{balancer_type})
414 if $opts{balancer_type};
415
b88b85e7 416 $self->balancer_args(
e666c5fd 417 $merge->merge((delete $opts{balancer_args} || {}), $self->balancer_args)
b88b85e7 418 );
dcdf7b2c 419
67c43863 420 $self->balancer($self->_build_balancer)
6f7344b8 421 if $self->balancer;
dcdf7b2c 422 }
423
b2e4d522 424 $self->_master_connect_info_opts(\%opts);
425
0ce2d0d5 426 my (@res, $res);
427 if ($wantarray) {
428 @res = $self->$next($info, @extra);
429 } else {
430 $res = $self->$next($info, @extra);
431 }
432
fd4eb9c2 433 # Make sure master is blessed into the correct class and apply role to it.
434 my $master = $self->master;
435 $master->_determine_driver;
436 Moose::Meta::Class->initialize(ref $master);
cea43436 437
ec0946db 438 DBIx::Class::Storage::DBI::Replicated::WithDSN->meta->apply($master);
cea43436 439
440 # link pool back to master
441 $self->pool->master($master);
0ce2d0d5 442
443 $wantarray ? @res : $res;
b2e4d522 444};
445
26ab719a 446=head1 METHODS
2bf79155 447
26ab719a 448This class defines the following methods.
2bf79155 449
c354902c 450=head2 BUILDARGS
2bf79155 451
faaba25f 452L<DBIx::Class::Schema> when instantiating its storage passed itself as the
2ce6e9a6 453first argument. So we need to massage the arguments a bit so that all the
454bits get put into the correct places.
2bf79155 455
456=cut
457
c354902c 458sub BUILDARGS {
d7a58a29 459 my ($class, $schema, $storage_type_args, @args) = @_;
d4daee7b 460
c354902c 461 return {
6f7344b8 462 schema=>$schema,
463 %$storage_type_args,
464 @args
c354902c 465 }
466}
2bf79155 467
cb6ec758 468=head2 _build_master
2bf79155 469
cb6ec758 470Lazy builder for the L</master> attribute.
2bf79155 471
472=cut
473
cb6ec758 474sub _build_master {
2ce6e9a6 475 my $self = shift @_;
ee356d00 476 my $master = DBIx::Class::Storage::DBI->new($self->schema);
ee356d00 477 $master
106d5f3b 478}
479
26ab719a 480=head2 _build_pool
2bf79155 481
26ab719a 482Lazy builder for the L</pool> attribute.
2bf79155 483
484=cut
485
26ab719a 486sub _build_pool {
64cdad22 487 my $self = shift @_;
488 $self->create_pool(%{$self->pool_args});
2bf79155 489}
490
26ab719a 491=head2 _build_balancer
2bf79155 492
cb6ec758 493Lazy builder for the L</balancer> attribute. This takes a Pool object so that
494the balancer knows which pool it's balancing.
2bf79155 495
496=cut
497
26ab719a 498sub _build_balancer {
64cdad22 499 my $self = shift @_;
500 $self->create_balancer(
6f7344b8 501 pool=>$self->pool,
64cdad22 502 master=>$self->master,
503 %{$self->balancer_args},
504 );
2bf79155 505}
506
cb6ec758 507=head2 _build_write_handler
2bf79155 508
cb6ec758 509Lazy builder for the L</write_handler> attribute. The default is to set this to
510the L</master>.
50336325 511
512=cut
513
cb6ec758 514sub _build_write_handler {
64cdad22 515 return shift->master;
cb6ec758 516}
50336325 517
cb6ec758 518=head2 _build_read_handler
2bf79155 519
cb6ec758 520Lazy builder for the L</read_handler> attribute. The default is to set this to
521the L</balancer>.
2bf79155 522
523=cut
524
cb6ec758 525sub _build_read_handler {
64cdad22 526 return shift->balancer;
cb6ec758 527}
50336325 528
cb6ec758 529=head2 around: connect_replicants
2bf79155 530
cb6ec758 531All calls to connect_replicants needs to have an existing $schema tacked onto
b2e4d522 532top of the args, since L<DBIx::Storage::DBI> needs it, and any C<connect_info>
533options merged with the master, with replicant opts having higher priority.
955a6df6 534
cb6ec758 535=cut
955a6df6 536
b2e4d522 537around connect_replicants => sub {
538 my ($next, $self, @args) = @_;
539
540 for my $r (@args) {
541 $r = [ $r ] unless reftype $r eq 'ARRAY';
542
1a58752c 543 $self->throw_exception('coderef replicant connect_info not supported')
b2e4d522 544 if ref $r->[0] && reftype $r->[0] eq 'CODE';
545
546# any connect_info options?
547 my $i = 0;
548 $i++ while $i < @$r && (reftype($r->[$i])||'') ne 'HASH';
549
6f7344b8 550# make one if none
b2e4d522 551 $r->[$i] = {} unless $r->[$i];
552
553# merge if two hashes
b88b85e7 554 my @hashes = @$r[$i .. $#{$r}];
555
1a58752c 556 $self->throw_exception('invalid connect_info options')
b88b85e7 557 if (grep { reftype($_) eq 'HASH' } @hashes) != @hashes;
558
1a58752c 559 $self->throw_exception('too many hashrefs in connect_info')
b88b85e7 560 if @hashes > 2;
561
282a9a4f 562 my $merge = Hash::Merge->new('LEFT_PRECEDENT');
e666c5fd 563 my %opts = %{ $merge->merge(reverse @hashes) };
b88b85e7 564
565# delete them
b2e4d522 566 splice @$r, $i+1, ($#{$r} - $i), ();
567
0bd8e058 568# make sure master/replicants opts don't clash
569 my %master_opts = %{ $self->_master_connect_info_opts };
570 if (exists $opts{dbh_maker}) {
571 delete @master_opts{qw/dsn user password/};
572 }
573 delete $master_opts{dbh_maker};
574
b2e4d522 575# merge with master
e666c5fd 576 %opts = %{ $merge->merge(\%opts, \%master_opts) };
b2e4d522 577
578# update
579 $r->[$i] = \%opts;
580 }
581
582 $self->$next($self->schema, @args);
955a6df6 583};
2bf79155 584
2bf79155 585=head2 all_storages
586
587Returns an array of of all the connected storage backends. The first element
588in the returned array is the master, and the remainings are each of the
589replicants.
590
591=cut
592
593sub all_storages {
64cdad22 594 my $self = shift @_;
595 return grep {defined $_ && blessed $_} (
596 $self->master,
6412a592 597 values %{ $self->replicants },
64cdad22 598 );
2bf79155 599}
600
c4d3fae2 601=head2 execute_reliably ($coderef, ?@args)
602
603Given a coderef, saves the current state of the L</read_handler>, forces it to
48580715 604use reliable storage (e.g. sets it to the master), executes a coderef and then
c4d3fae2 605restores the original state.
606
607Example:
608
64cdad22 609 my $reliably = sub {
610 my $name = shift @_;
611 $schema->resultset('User')->create({name=>$name});
612 my $user_rs = $schema->resultset('User')->find({name=>$name});
613 return $user_rs;
614 };
c4d3fae2 615
64cdad22 616 my $user_rs = $schema->storage->execute_reliably($reliably, 'John');
c4d3fae2 617
618Use this when you must be certain of your database state, such as when you just
619inserted something and need to get a resultset including it, etc.
620
621=cut
622
623sub execute_reliably {
64cdad22 624 my ($self, $coderef, @args) = @_;
d4daee7b 625
64cdad22 626 unless( ref $coderef eq 'CODE') {
627 $self->throw_exception('Second argument must be a coderef');
628 }
d4daee7b 629
64cdad22 630 ##Get copy of master storage
631 my $master = $self->master;
d4daee7b 632
64cdad22 633 ##Get whatever the current read hander is
634 my $current = $self->read_handler;
d4daee7b 635
64cdad22 636 ##Set the read handler to master
637 $self->read_handler($master);
d4daee7b 638
64cdad22 639 ## do whatever the caller needs
640 my @result;
641 my $want_array = wantarray;
d4daee7b 642
64cdad22 643 eval {
644 if($want_array) {
645 @result = $coderef->(@args);
646 } elsif(defined $want_array) {
647 ($result[0]) = ($coderef->(@args));
ed213e85 648 } else {
64cdad22 649 $coderef->(@args);
6f7344b8 650 }
64cdad22 651 };
d4daee7b 652
64cdad22 653 ##Reset to the original state
6f7344b8 654 $self->read_handler($current);
d4daee7b 655
64cdad22 656 ##Exception testing has to come last, otherwise you might leave the
657 ##read_handler set to master.
d4daee7b 658
64cdad22 659 if($@) {
660 $self->throw_exception("coderef returned an error: $@");
661 } else {
662 return $want_array ? @result : $result[0];
663 }
c4d3fae2 664}
665
cb6ec758 666=head2 set_reliable_storage
667
668Sets the current $schema to be 'reliable', that is all queries, both read and
669write are sent to the master
d4daee7b 670
cb6ec758 671=cut
672
673sub set_reliable_storage {
64cdad22 674 my $self = shift @_;
675 my $schema = $self->schema;
676 my $write_handler = $self->schema->storage->write_handler;
d4daee7b 677
64cdad22 678 $schema->storage->read_handler($write_handler);
cb6ec758 679}
680
681=head2 set_balanced_storage
682
683Sets the current $schema to be use the </balancer> for all reads, while all
48580715 684writes are sent to the master only
d4daee7b 685
cb6ec758 686=cut
687
688sub set_balanced_storage {
64cdad22 689 my $self = shift @_;
690 my $schema = $self->schema;
bd5da369 691 my $balanced_handler = $self->schema->storage->balancer;
d4daee7b 692
bd5da369 693 $schema->storage->read_handler($balanced_handler);
cb6ec758 694}
2bf79155 695
696=head2 connected
697
698Check that the master and at least one of the replicants is connected.
699
700=cut
701
702sub connected {
64cdad22 703 my $self = shift @_;
704 return
705 $self->master->connected &&
706 $self->pool->connected_replicants;
2bf79155 707}
708
2bf79155 709=head2 ensure_connected
710
711Make sure all the storages are connected.
712
713=cut
714
715sub ensure_connected {
64cdad22 716 my $self = shift @_;
717 foreach my $source ($self->all_storages) {
718 $source->ensure_connected(@_);
719 }
2bf79155 720}
721
2bf79155 722=head2 limit_dialect
723
724Set the limit_dialect for all existing storages
725
726=cut
727
728sub limit_dialect {
64cdad22 729 my $self = shift @_;
730 foreach my $source ($self->all_storages) {
731 $source->limit_dialect(@_);
732 }
3fbe08e3 733 return $self->master->quote_char;
2bf79155 734}
735
2bf79155 736=head2 quote_char
737
738Set the quote_char for all existing storages
739
740=cut
741
742sub quote_char {
64cdad22 743 my $self = shift @_;
744 foreach my $source ($self->all_storages) {
745 $source->quote_char(@_);
746 }
3fbe08e3 747 return $self->master->quote_char;
2bf79155 748}
749
2bf79155 750=head2 name_sep
751
752Set the name_sep for all existing storages
753
754=cut
755
756sub name_sep {
64cdad22 757 my $self = shift @_;
758 foreach my $source ($self->all_storages) {
759 $source->name_sep(@_);
760 }
3fbe08e3 761 return $self->master->name_sep;
2bf79155 762}
763
2bf79155 764=head2 set_schema
765
766Set the schema object for all existing storages
767
768=cut
769
770sub set_schema {
64cdad22 771 my $self = shift @_;
772 foreach my $source ($self->all_storages) {
773 $source->set_schema(@_);
774 }
2bf79155 775}
776
2bf79155 777=head2 debug
778
779set a debug flag across all storages
780
781=cut
782
783sub debug {
64cdad22 784 my $self = shift @_;
3fbe08e3 785 if(@_) {
786 foreach my $source ($self->all_storages) {
787 $source->debug(@_);
6f7344b8 788 }
64cdad22 789 }
3fbe08e3 790 return $self->master->debug;
2bf79155 791}
792
2bf79155 793=head2 debugobj
794
cea43436 795set a debug object
2bf79155 796
797=cut
798
799sub debugobj {
64cdad22 800 my $self = shift @_;
cea43436 801 return $self->master->debugobj(@_);
2bf79155 802}
803
2bf79155 804=head2 debugfh
805
cea43436 806set a debugfh object
2bf79155 807
808=cut
809
810sub debugfh {
64cdad22 811 my $self = shift @_;
cea43436 812 return $self->master->debugfh(@_);
2bf79155 813}
814
2bf79155 815=head2 debugcb
816
cea43436 817set a debug callback
2bf79155 818
819=cut
820
821sub debugcb {
64cdad22 822 my $self = shift @_;
cea43436 823 return $self->master->debugcb(@_);
2bf79155 824}
825
2bf79155 826=head2 disconnect
827
828disconnect everything
829
830=cut
831
832sub disconnect {
64cdad22 833 my $self = shift @_;
834 foreach my $source ($self->all_storages) {
835 $source->disconnect(@_);
836 }
2bf79155 837}
838
b2e4d522 839=head2 cursor_class
840
841set cursor class on all storages, or return master's
842
843=cut
844
845sub cursor_class {
846 my ($self, $cursor_class) = @_;
847
848 if ($cursor_class) {
849 $_->cursor_class($cursor_class) for $self->all_storages;
850 }
851 $self->master->cursor_class;
852}
d4daee7b 853
3244fdcc 854=head2 cursor
855
856set cursor class on all storages, or return master's, alias for L</cursor_class>
857above.
858
859=cut
860
861sub cursor {
862 my ($self, $cursor_class) = @_;
863
864 if ($cursor_class) {
865 $_->cursor($cursor_class) for $self->all_storages;
866 }
867 $self->master->cursor;
868}
869
870=head2 unsafe
871
872sets the L<DBIx::Class::Storage::DBI/unsafe> option on all storages or returns
873master's current setting
874
875=cut
876
877sub unsafe {
878 my $self = shift;
879
880 if (@_) {
881 $_->unsafe(@_) for $self->all_storages;
882 }
883
884 return $self->master->unsafe;
885}
886
887=head2 disable_sth_caching
888
889sets the L<DBIx::Class::Storage::DBI/disable_sth_caching> option on all storages
890or returns master's current setting
891
892=cut
893
894sub disable_sth_caching {
895 my $self = shift;
896
897 if (@_) {
898 $_->disable_sth_caching(@_) for $self->all_storages;
899 }
900
901 return $self->master->disable_sth_caching;
902}
903
904=head2 lag_behind_master
905
906returns the highest Replicant L<DBIx::Class::Storage::DBI/lag_behind_master>
907setting
908
909=cut
910
911sub lag_behind_master {
912 my $self = shift;
913
914 return max map $_->lag_behind_master, $self->replicants;
915}
916
917=head2 is_replicating
918
919returns true if all replicants return true for
920L<DBIx::Class::Storage::DBI/is_replicating>
921
922=cut
923
924sub is_replicating {
925 my $self = shift;
926
927 return (grep $_->is_replicating, $self->replicants) == ($self->replicants);
928}
929
930=head2 connect_call_datetime_setup
931
932calls L<DBIx::Class::Storage::DBI/connect_call_datetime_setup> for all storages
933
934=cut
935
936sub connect_call_datetime_setup {
937 my $self = shift;
938 $_->connect_call_datetime_setup for $self->all_storages;
939}
940
941sub _populate_dbh {
942 my $self = shift;
943 $_->_populate_dbh for $self->all_storages;
944}
945
946sub _connect {
947 my $self = shift;
948 $_->_connect for $self->all_storages;
949}
950
951sub _rebless {
952 my $self = shift;
953 $_->_rebless for $self->all_storages;
954}
955
956sub _determine_driver {
957 my $self = shift;
958 $_->_determine_driver for $self->all_storages;
959}
960
961sub _driver_determined {
962 my $self = shift;
963
964 if (@_) {
965 $_->_driver_determined(@_) for $self->all_storages;
966 }
967
968 return $self->master->_driver_determined;
969}
970
971sub _init {
972 my $self = shift;
973
974 $_->_init for $self->all_storages;
975}
976
977sub _run_connection_actions {
978 my $self = shift;
979
980 $_->_run_connection_actions for $self->all_storages;
981}
982
983sub _do_connection_actions {
984 my $self = shift;
985
986 if (@_) {
987 $_->_do_connection_actions(@_) for $self->all_storages;
988 }
989}
990
991sub connect_call_do_sql {
992 my $self = shift;
993 $_->connect_call_do_sql(@_) for $self->all_storages;
994}
995
996sub disconnect_call_do_sql {
997 my $self = shift;
998 $_->disconnect_call_do_sql(@_) for $self->all_storages;
999}
1000
1001sub _seems_connected {
1002 my $self = shift;
1003
1004 return min map $_->_seems_connected, $self->all_storages;
1005}
1006
1007sub _ping {
1008 my $self = shift;
1009
1010 return min map $_->_ping, $self->all_storages;
1011}
1012
fecb38cb 1013sub _server_info {
1014 my $self = shift;
1015
1016 if (not $self->_server_info_hash) {
1017 no warnings 'numeric'; # in case dbms_version doesn't normalize
1018
1019 my @infos =
1020 map $_->[1],
1021 sort { $a->[0] <=> $b->[0] }
1022 map [ (defined $_->{normalized_dbms_version} ? $_->{normalized_dbms_version}
1023 : $_->{dbms_version}), $_ ],
1024 map $_->_server_info, $self->all_storages;
1025
1026 my $min_version_info = $infos[0];
1027
1028 $self->_server_info_hash($min_version_info); # on master
1029 }
1030
1031 return $self->_server_info_hash;
1032}
1033
1034sub _get_server_version {
1035 my $self = shift;
1036
1037 return $self->_server_info->{dbms_version};
1038}
1039
7e38d850 1040=head1 GOTCHAS
1041
1042Due to the fact that replicants can lag behind a master, you must take care to
1043make sure you use one of the methods to force read queries to a master should
1044you need realtime data integrity. For example, if you insert a row, and then
1045immediately re-read it from the database (say, by doing $row->discard_changes)
1046or you insert a row and then immediately build a query that expects that row
1047to be an item, you should force the master to handle reads. Otherwise, due to
1048the lag, there is no certainty your data will be in the expected state.
1049
1050For data integrity, all transactions automatically use the master storage for
1051all read and write queries. Using a transaction is the preferred and recommended
1052method to force the master to handle all read queries.
1053
1054Otherwise, you can force a single query to use the master with the 'force_pool'
1055attribute:
1056
1057 my $row = $resultset->search(undef, {force_pool=>'master'})->find($pk);
1058
1059This attribute will safely be ignore by non replicated storages, so you can use
1060the same code for both types of systems.
1061
1062Lastly, you can use the L</execute_reliably> method, which works very much like
1063a transaction.
1064
1065For debugging, you can turn replication on/off with the methods L</set_reliable_storage>
1066and L</set_balanced_storage>, however this operates at a global level and is not
1067suitable if you have a shared Schema object being used by multiple processes,
1068such as on a web application server. You can get around this limitation by
1069using the Schema clone method.
1070
1071 my $new_schema = $schema->clone;
1072 $new_schema->set_reliable_storage;
d4daee7b 1073
7e38d850 1074 ## $new_schema will use only the Master storage for all reads/writes while
1075 ## the $schema object will use replicated storage.
1076
f5d3a5de 1077=head1 AUTHOR
1078
64cdad22 1079 John Napiorkowski <john.napiorkowski@takkle.com>
f5d3a5de 1080
c4d3fae2 1081Based on code originated by:
f5d3a5de 1082
64cdad22 1083 Norbert Csongrádi <bert@cpan.org>
1084 Peter Siklósi <einon@einon.hu>
2156bbdd 1085
f5d3a5de 1086=head1 LICENSE
1087
1088You may distribute this code under the same terms as Perl itself.
1089
1090=cut
1091
c354902c 1092__PACKAGE__->meta->make_immutable;
1093
f5d3a5de 10941;