1 package Catalyst::TraitFor::Model::DBIC::Schema::Replicated;
3 use namespace::autoclean;
5 use Carp::Clan '^Catalyst::Model::DBIC::Schema';
7 use Catalyst::Model::DBIC::Schema::Types qw/ConnectInfos LoadableClass/;
8 use MooseX::Types::Moose qw/Str HashRef/;
10 use Module::Runtime qw/use_module/;
14 Catalyst::TraitFor::Model::DBIC::Schema::Replicated - Replicated storage support for
15 L<Catalyst::Model::DBIC::Schema>
20 traits => ['Replicated']
22 ['dbi:mysql:master', 'user', 'pass'],
24 ['dbi:mysql:slave1', 'user', 'pass'],
25 ['dbi:mysql:slave2', 'user', 'pass'],
26 ['dbi:mysql:slave3', 'user', 'pass'],
29 master_read_weight => 0.3
35 Sets your storage_type to L<DBIx::Class::Storage::DBI::Replicated> and connects
36 replicants provided in config. See that module for supported resultset
39 The default L<DBIx::Class::Storage::DBI::Replicated/balancer_type> is
43 L<DBIx::Class::Storage::DBI::Replicated::Balancer::Random/master_read_weight> to
44 C<1> by default, meaning that you have the same chance of reading from master as
45 you do from replicants. Set to C<0> to turn off reads from master.
47 =head1 CONFIG PARAMETERS
51 Array of connect_info settings for every replicant.
53 The following can be set via L<Catalyst::Model::DBIC::Schema/connect_info>, or
54 as their own parameters. If set via separate parameters, they will override the
55 settings in C<connect_info>.
59 See L<DBIx::Class::Storage::DBI::Replicated/pool_type>.
63 See L<DBIx::Class::Storage::DBI::Replicated/pool_args>.
67 See L<DBIx::Class::Storage::DBI::Replicated/balancer_type>.
71 See L<DBIx::Class::Storage::DBI::Replicated/balancer_args>.
76 is => 'ro', isa => ConnectInfos, coerce => 1, required => 1
79 has pool_type => (is => 'ro', isa => LoadableClass);
80 has pool_args => (is => 'ro', isa => HashRef);
81 has balancer_type => (is => 'ro', isa => Str);
82 has balancer_args => (is => 'ro', isa => HashRef);
87 # check storage_type compatibility (if configured)
88 if (my $storage_type = $self->storage_type) {
89 my $class = $storage_type =~ /^::/ ?
90 "DBIx::Class::Storage$storage_type"
95 croak "This storage_type cannot be used with replication"
96 unless $class->isa('DBIx::Class::Storage::DBI::Replicated');
98 $self->storage_type('::DBI::Replicated');
101 my $connect_info = $self->connect_info;
103 $connect_info->{pool_type} = $self->pool_type
106 $connect_info->{pool_args} = $self->pool_args
109 $connect_info->{balancer_type} = $self->balancer_type ||
110 $connect_info->{balancer_type} || '::Random';
112 $connect_info->{balancer_args} = $self->balancer_args ||
113 $connect_info->{balancer_args} || {};
115 $connect_info->{balancer_args}{master_read_weight} = 1
116 unless exists $connect_info->{balancer_args}{master_read_weight};
124 $self->storage->connect_replicants(map [ $_ ], @{ $self->replicants });
129 L<Catalyst::Model::DBIC::Schema>, L<DBIx::Class>,
130 L<DBIx::Class::Storage::DBI::Replicated>,
131 L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>
135 See L<Catalyst::Model::DBIC::Schema/AUTHOR> and
136 L<Catalyst::Model::DBIC::Schema/CONTRIBUTORS>.
140 See L<Catalyst::Model::DBIC::Schema/COPYRIGHT>.
144 This program is free software, you can redistribute it and/or modify it
145 under the same terms as Perl itself.