.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "DBIx::Class::Storage::DBI::Replicated::Replicant 3pm"
.TH DBIx::Class::Storage::DBI::Replicated::Replicant 3pm "2018-04-19" "perl v5.26.2" "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"
DBIx::Class::Storage::DBI::Replicated::Replicant \- A replicated DBI Storage Role
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This class is used internally by DBIx::Class::Storage::DBI::Replicated.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Replicants are \s-1DBI\s0 Storages that follow a master \s-1DBI\s0 Storage.  Typically this
is accomplished via an external replication system.  Please see the documents
for DBIx::Class::Storage::DBI::Replicated for more details.
.PP
This class exists to define methods of a \s-1DBI\s0 Storage that only make sense when
it's a classic 'slave' in a pool of slave databases which replicate from a
given master database.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
This class defines the following attributes.
.SS "active"
.IX Subsection "active"
This is a boolean which allows you to programmatically activate or deactivate a
replicant from the pool.  This way you can do stuff like disallow a replicant
when it gets too far behind the master, if it stops replicating, etc.
.PP
This attribute \s-1DOES NOT\s0 reflect a replicant's internal status, i.e. if it is
properly replicating from a master and has not fallen too many seconds behind a
reliability threshold. For that, use
\&\*(L"is_replicating\*(R" in DBIx::Class::Storage::DBI::Replicated and
\&\*(L"lag_behind_master\*(R" in DBIx::Class::Storage::DBI::Replicated.
Since the implementation of those functions database specific (and not all \s-1DBIC\s0
supported DBs support replication) you should refer your database-specific
storage driver for more information.
.SS "master"
.IX Subsection "master"
Reference to the master Storage.
.SH "METHODS"
.IX Header "METHODS"
This class defines the following methods.
.SS "debugobj"
.IX Subsection "debugobj"
Override the debugobj method to redirect this method call back to the master.
.SH "ALSO SEE"
.IX Header "ALSO SEE"
<http://en.wikipedia.org/wiki/Replicant>,
DBIx::Class::Storage::DBI::Replicated
.SH "FURTHER QUESTIONS?"
.IX Header "FURTHER QUESTIONS?"
Check the list of additional \s-1DBIC\s0 resources.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This module is free software copyright
by the DBIx::Class (\s-1DBIC\s0) authors. You can
redistribute it and/or modify it under the same terms as the
DBIx::Class library.