NAME

DBIx::Class::Storage::DBI::Replicated::Replicant - A replicated DBI Storage Role

SYNOPSIS

This class is used internally by the DBIx::Class::Storage::DBI::Replicated manpage.

=head1 DESCRIPTION

Replicants are DBI Storages that follow a master DBI Storage. Typically this is accomplished via an external replication system. Please see the documents for the DBIx::Class::Storage::DBI::Replicated manpage for more details.

This class exists to define methods of a DBI Storage that only make sense when it's a classic 'slave' in a pool of slave databases which replicate from a given master database.

ATTRIBUTES

This class defines the following attributes.

active

This is a boolean which allows you to programmatically activate or deactivate a replicant from the pool. This way to you do stuff like disallow a replicant when it get's too far behind the master, if it stops replicating, etc.

This attribute DOES NOT 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 is_replicating and lag_behind_master. Since the implementation of those functions database specific (and not all DBIC supported DB's support replication) you should refer your database specific storage driver for more information.

METHODS

This class defines the following methods.

debugobj

Override the debugobj method to redirect this method call back to the master.

ALSO SEE

http://en.wikipedia.org/wiki/Replicant, the DBIx::Class::Storage::DBI::Replicated manpage

AUTHOR

John Napiorkowski <john.napiorkowski@takkle.com>

LICENSE

You may distribute this code under the same terms as Perl itself.