lib/DBIx/Class/Storage/DBI/Replicated/Replicant.pm

   1 package DBIx::Class::Storage::DBI::Replicated::Replicant;
   2
   3 use Moose;
   4 extends 'DBIx::Class::Storage::DBI', 'Moose::Object';
   5
   6 =head1 NAME
   7
   8 DBIx::Class::Storage::DBI::Replicated::Replicant; A replicated DBI Storage
   9
  10 =head1 SYNOPSIS
  11
  12 This class is used internally by L<DBIx::Class::Storage::DBI::Replicated>.  You
  13 shouldn't need to create instances of this class.
  14
  15 =head1 DESCRIPTION
  16
  17 Replicants are DBI Storages that follow a master DBI Storage.  Typically this
  18 is accomplished via an external replication system.  Please see the documents
  19 for L<DBIx::Class::Storage::DBI::Replicated> for more details.
  20
  21 This class exists to define methods of a DBI Storage that only make sense when
  22 it's a classic 'slave' in a pool of slave databases which replicate from a
  23 given master database.
  24
  25 =head1 ATTRIBUTES
  26
  27 This class defines the following attributes.
  28
  29 =head1 METHODS
  30
  31 This class defines the following methods.
  32
  33 =head1 AUTHOR
  34
  35 John Napiorkowski <john.napiorkowski@takkle.com>
  36
  37 =head1 LICENSE
  38
  39 You may distribute this code under the same terms as Perl itself.
  40
  41 =cut