.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Catalyst::TraitFor::Model::DBIC::Schema::Replicated 3pm"
.TH Catalyst::TraitFor::Model::DBIC::Schema::Replicated 3pm "2023-10-26" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Catalyst::TraitFor::Model::DBIC::Schema::Replicated \- Replicated storage support for
Catalyst::Model::DBIC::Schema
.SH "SYNOPSiS"
.IX Header "SYNOPSiS"
.Vb 10
\&    _\|_PACKAGE_\|_\->config({
\&        traits => [\*(AqReplicated\*(Aq]
\&        connect_info =>
\&            [\*(Aqdbi:mysql:master\*(Aq, \*(Aquser\*(Aq, \*(Aqpass\*(Aq],
\&        replicants => [
\&            [\*(Aqdbi:mysql:slave1\*(Aq, \*(Aquser\*(Aq, \*(Aqpass\*(Aq],
\&            [\*(Aqdbi:mysql:slave2\*(Aq, \*(Aquser\*(Aq, \*(Aqpass\*(Aq],
\&            [\*(Aqdbi:mysql:slave3\*(Aq, \*(Aquser\*(Aq, \*(Aqpass\*(Aq],
\&        ],
\&        balancer_args => {
\&          master_read_weight => 0.3
\&        }
\&    });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sets your storage_type to DBIx::Class::Storage::DBI::Replicated and connects
replicants provided in config. See that module for supported resultset
attributes.
.PP
The default \*(L"balancer_type\*(R" in DBIx::Class::Storage::DBI::Replicated is
\&\f(CW\*(C`::Random\*(C'\fR.
.PP
Sets the
\&\*(L"master_read_weight\*(R" in DBIx::Class::Storage::DBI::Replicated::Balancer::Random to
\&\f(CW1\fR by default, meaning that you have the same chance of reading from master as
you do from replicants. Set to \f(CW0\fR to turn off reads from master.
.SH "CONFIG PARAMETERS"
.IX Header "CONFIG PARAMETERS"
.SS "replicants"
.IX Subsection "replicants"
Array of connect_info settings for every replicant.
.PP
The following can be set via \*(L"connect_info\*(R" in Catalyst::Model::DBIC::Schema, or
as their own parameters. If set via separate parameters, they will override the
settings in \f(CW\*(C`connect_info\*(C'\fR.
.SS "pool_type"
.IX Subsection "pool_type"
See \*(L"pool_type\*(R" in DBIx::Class::Storage::DBI::Replicated.
.SS "pool_args"
.IX Subsection "pool_args"
See \*(L"pool_args\*(R" in DBIx::Class::Storage::DBI::Replicated.
.SS "balancer_type"
.IX Subsection "balancer_type"
See \*(L"balancer_type\*(R" in DBIx::Class::Storage::DBI::Replicated.
.SS "balancer_args"
.IX Subsection "balancer_args"
See \*(L"balancer_args\*(R" in DBIx::Class::Storage::DBI::Replicated.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst::Model::DBIC::Schema, DBIx::Class,
DBIx::Class::Storage::DBI::Replicated,
Catalyst::TraitFor::Model::DBIC::Schema::Caching
.SH "AUTHOR"
.IX Header "AUTHOR"
See \*(L"\s-1AUTHOR\*(R"\s0 in Catalyst::Model::DBIC::Schema and
\&\*(L"\s-1CONTRIBUTORS\*(R"\s0 in Catalyst::Model::DBIC::Schema.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
See \*(L"\s-1COPYRIGHT\*(R"\s0 in Catalyst::Model::DBIC::Schema.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software, you can redistribute it and/or modify it
under the same terms as Perl itself.