X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FStorage%2FDBI%2FReplicated.pm;h=d8a5f6dc8c812eb2da873cc548755ddc4a31a183;hb=4225194590a09e29451ba825c34483f98c1a0c03;hp=c583c6e58edcf3655cee7d1e2a97683791a0677a;hpb=6a151f5877412d2824295071428c52eb4bf646ec;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Storage/DBI/Replicated.pm b/lib/DBIx/Class/Storage/DBI/Replicated.pm index c583c6e..d8a5f6d 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated.pm +++ b/lib/DBIx/Class/Storage/DBI/Replicated.pm @@ -2,28 +2,27 @@ package DBIx::Class::Storage::DBI::Replicated; BEGIN { use Carp::Clan qw/^DBIx::Class/; - + ## Modules required for Replication support not required for general DBIC ## use, so we explicitly test for these. - + my %replication_required = ( - 'Moose' => '0.77', - 'MooseX::AttributeHelpers' => '0.12', - 'MooseX::Types' => '0.10', + 'Moose' => '0.90', + 'MooseX::Types' => '0.16', 'namespace::clean' => '0.11', 'Hash::Merge' => '0.11' ); - + my @didnt_load; - + for my $module (keys %replication_required) { - eval "use $module $replication_required{$module}"; - push @didnt_load, "$module $replication_required{$module}" - if $@; + eval "use $module $replication_required{$module}"; + push @didnt_load, "$module $replication_required{$module}" + if $@; } - + croak("@{[ join ', ', @didnt_load ]} are missing and are required for Replication") - if @didnt_load; + if @didnt_load; } use Moose; @@ -33,7 +32,6 @@ use DBIx::Class::Storage::DBI::Replicated::Balancer; use DBIx::Class::Storage::DBI::Replicated::Types qw/BalancerClassNamePart DBICSchema DBICStorageDBI/; use MooseX::Types::Moose qw/ClassName HashRef Object/; use Scalar::Util 'reftype'; -use Carp::Clan qw/^DBIx::Class/; use Hash::Merge 'merge'; use namespace::clean -except => 'meta'; @@ -49,29 +47,29 @@ storage type, add some replicated (readonly) databases, and perform reporting tasks. You should set the 'storage_type attribute to a replicated type. You should -also defined you arguments, such as which balancer you want and any arguments +also define your arguments, such as which balancer you want and any arguments that the Pool object should get. $schema->storage_type( ['::DBI::Replicated', {balancer=>'::Random'}] ); - + Next, you need to add in the Replicants. Basically this is an array of arrayrefs, where each arrayref is database connect information. Think of these arguments as what you'd pass to the 'normal' $schema->connect method. - + $schema->storage->connect_replicants( [$dsn1, $user, $pass, \%opts], [$dsn2, $user, $pass, \%opts], [$dsn3, $user, $pass, \%opts], ); - + Now, just use the $schema as you normally would. Automatically all reads will be delegated to the replicants, while writes to the master. $schema->resultset('Source')->search({name=>'etc'}); - + You can force a given query to use a particular storage using the search attribute 'force_pool'. For example: - + my $RS = $schema->resultset('Source')->search(undef, {force_pool=>'master'}); Now $RS will force everything (both reads and writes) to use whatever was setup @@ -86,7 +84,7 @@ same time, since your replicants will often lag a bit behind the master. See L for more help and walkthroughs. - + =head1 DESCRIPTION Warning: This class is marked BETA. This has been running a production @@ -112,7 +110,7 @@ selected algorithm. The default algorithm is random weighted. =head1 NOTES The consistancy betweeen master and replicants is database specific. The Pool -gives you a method to validate it's replicants, removing and replacing them +gives you a method to validate its replicants, removing and replacing them when they fail/pass predefined criteria. Please make careful use of the ways to force a query to run against Master when needed. @@ -120,12 +118,11 @@ to force a query to run against Master when needed. Replicated Storage has additional requirements not currently part of L - Moose => 0.77 - MooseX::AttributeHelpers => 0.12 - MooseX::Types => 0.10 - namespace::clean => 0.11 - Hash::Merge => 0.11 - + Moose => '0.90', + MooseX::Types => '0.16', + namespace::clean => '0.11', + Hash::Merge => '0.11' + You will need to install these modules manually via CPAN or make them part of the Makefile for your distribution. @@ -222,7 +219,7 @@ has 'pool' => ( isa=>'DBIx::Class::Storage::DBI::Replicated::Pool', lazy_build=>1, handles=>[qw/ - connect_replicants + connect_replicants replicants has_replicants /], @@ -277,7 +274,7 @@ has 'read_handler' => ( select select_single columns_info_for - /], + /], ); =head2 write_handler @@ -290,9 +287,9 @@ has 'write_handler' => ( is=>'ro', isa=>Object, lazy_build=>1, - handles=>[qw/ + handles=>[qw/ on_connect_do - on_disconnect_do + on_disconnect_do connect_info throw_exception sql_maker @@ -300,8 +297,8 @@ has 'write_handler' => ( create_ddl_dir deployment_statements datetime_parser - datetime_parser_type - build_datetime_parser + datetime_parser_type + build_datetime_parser last_insert_id insert insert_bulk @@ -316,19 +313,19 @@ has 'write_handler' => ( sth deploy with_deferred_fk_checks - dbh_do + dbh_do reload_row - with_deferred_fk_checks + with_deferred_fk_checks _prep_for_execute - backup - is_datatype_numeric - _count_select - _subq_count_select - _subq_update_delete - svp_rollback - svp_begin - svp_release + backup + is_datatype_numeric + _count_select + _subq_count_select + _subq_update_delete + svp_rollback + svp_begin + svp_release /], ); @@ -364,7 +361,7 @@ around connect_info => sub { ); $self->pool($self->_build_pool) - if $self->pool; + if $self->pool; } if (@opts{qw/balancer_type balancer_args/}) { @@ -376,7 +373,7 @@ around connect_info => sub { ); $self->balancer($self->_build_balancer) - if $self->balancer; + if $self->balancer; } $self->_master_connect_info_opts(\%opts); @@ -403,7 +400,7 @@ This class defines the following methods. =head2 BUILDARGS -L when instantiating it's storage passed itself as the +L when instantiating its storage passed itself as the first argument. So we need to massage the arguments a bit so that all the bits get put into the correct places. @@ -411,11 +408,11 @@ bits get put into the correct places. sub BUILDARGS { my ($class, $schema, $storage_type_args, @args) = @_; - + return { - schema=>$schema, - %$storage_type_args, - @args + schema=>$schema, + %$storage_type_args, + @args } } @@ -452,7 +449,7 @@ the balancer knows which pool it's balancing. sub _build_balancer { my $self = shift @_; $self->create_balancer( - pool=>$self->pool, + pool=>$self->pool, master=>$self->master, %{$self->balancer_args}, ); @@ -494,23 +491,23 @@ around connect_replicants => sub { for my $r (@args) { $r = [ $r ] unless reftype $r eq 'ARRAY'; - croak "coderef replicant connect_info not supported" + $self->throw_exception('coderef replicant connect_info not supported') if ref $r->[0] && reftype $r->[0] eq 'CODE'; # any connect_info options? my $i = 0; $i++ while $i < @$r && (reftype($r->[$i])||'') ne 'HASH'; -# make one if none +# make one if none $r->[$i] = {} unless $r->[$i]; # merge if two hashes my @hashes = @$r[$i .. $#{$r}]; - croak "invalid connect_info options" + $self->throw_exception('invalid connect_info options') if (grep { reftype($_) eq 'HASH' } @hashes) != @hashes; - croak "too many hashrefs in connect_info" + $self->throw_exception('too many hashrefs in connect_info') if @hashes > 2; my %opts = %{ merge(reverse @hashes) }; @@ -518,8 +515,15 @@ around connect_replicants => sub { # delete them splice @$r, $i+1, ($#{$r} - $i), (); +# make sure master/replicants opts don't clash + my %master_opts = %{ $self->_master_connect_info_opts }; + if (exists $opts{dbh_maker}) { + delete @master_opts{qw/dsn user password/}; + } + delete $master_opts{dbh_maker}; + # merge with master - %opts = %{ merge(\%opts, $self->_master_connect_info_opts) }; + %opts = %{ merge(\%opts, \%master_opts) }; # update $r->[$i] = \%opts; @@ -568,24 +572,24 @@ inserted something and need to get a resultset including it, etc. sub execute_reliably { my ($self, $coderef, @args) = @_; - + unless( ref $coderef eq 'CODE') { $self->throw_exception('Second argument must be a coderef'); } - + ##Get copy of master storage my $master = $self->master; - + ##Get whatever the current read hander is my $current = $self->read_handler; - + ##Set the read handler to master $self->read_handler($master); - + ## do whatever the caller needs my @result; my $want_array = wantarray; - + eval { if($want_array) { @result = $coderef->(@args); @@ -593,15 +597,15 @@ sub execute_reliably { ($result[0]) = ($coderef->(@args)); } else { $coderef->(@args); - } + } }; - + ##Reset to the original state - $self->read_handler($current); - + $self->read_handler($current); + ##Exception testing has to come last, otherwise you might leave the ##read_handler set to master. - + if($@) { $self->throw_exception("coderef returned an error: $@"); } else { @@ -613,14 +617,14 @@ sub execute_reliably { Sets the current $schema to be 'reliable', that is all queries, both read and write are sent to the master - + =cut sub set_reliable_storage { my $self = shift @_; my $schema = $self->schema; my $write_handler = $self->schema->storage->write_handler; - + $schema->storage->read_handler($write_handler); } @@ -628,14 +632,14 @@ sub set_reliable_storage { Sets the current $schema to be use the for all reads, while all writea are sent to the master only - + =cut sub set_balanced_storage { my $self = shift @_; my $schema = $self->schema; my $balanced_handler = $self->schema->storage->balancer; - + $schema->storage->read_handler($balanced_handler); } @@ -731,7 +735,7 @@ sub debug { if(@_) { foreach my $source ($self->all_storages) { $source->debug(@_); - } + } } return $self->master->debug; } @@ -747,7 +751,7 @@ sub debugobj { if(@_) { foreach my $source ($self->all_storages) { $source->debugobj(@_); - } + } } return $self->master->debugobj; } @@ -763,7 +767,7 @@ sub debugfh { if(@_) { foreach my $source ($self->all_storages) { $source->debugfh(@_); - } + } } return $self->master->debugfh; } @@ -779,7 +783,7 @@ sub debugcb { if(@_) { foreach my $source ($self->all_storages) { $source->debugcb(@_); - } + } } return $self->master->debugcb; } @@ -811,7 +815,7 @@ sub cursor_class { } $self->master->cursor_class; } - + =head1 GOTCHAS Due to the fact that replicants can lag behind a master, you must take care to @@ -845,7 +849,7 @@ using the Schema clone method. my $new_schema = $schema->clone; $new_schema->set_reliable_storage; - + ## $new_schema will use only the Master storage for all reads/writes while ## the $schema object will use replicated storage.