lib/DBIx/Class/Schema/Loader/DBI/Writing.pm

   1 package DBIx::Class::Schema::Loader::DBI::Writing;
   2 use strict;
   3
   4 # Empty. POD only.
   5
   6 1;
   7
   8 =head1 NAME
   9
  10 DBIx::Class::Schema::Loader::DBI::Writing - Loader subclass writing guide for DBI
  11
  12 =head1 SYNOPSIS
  13
  14   package DBIx::Class::Schema::Loader::DBI::Foo;
  15
  16   # THIS IS JUST A TEMPLATE TO GET YOU STARTED.
  17
  18   use strict;
  19   use warnings;
  20   use base 'DBIx::Class::Schema::Loader::DBI';
  21   use Carp::Clan qw/^DBIx::Class::Schema::Loader/;
  22   use Class::C3;
  23
  24   sub _table_uniq_info {
  25       my ($self, $table) = @_;
  26
  27       # ... get UNIQUE info for $table somehow
  28       # and return a data structure that looks like this:
  29
  30       return [
  31          [ 'keyname' => [ 'colname' ] ],
  32          [ 'keyname2' => [ 'col1name', 'col2name' ] ],
  33          [ 'keyname3' => [ 'colname' ] ],
  34       ];
  35
  36       # Where the "keyname"'s are just unique identifiers, such as the
  37       # name of the unique constraint, or the names of the columns involved
  38       # concatenated if you wish.
  39   }
  40
  41   1;
  42
  43 =head1 DETAILS
  44
  45 The only required method for new subclasses is C<_table_uniq_info>,
  46 as there is not (yet) any standardized, DBD-agnostic way for obtaining
  47 this information from DBI.
  48
  49 The base DBI Loader contains generic methods that *should* work for
  50 everything else in theory, although in practice some DBDs need to
  51 override one or more of the other methods.  The other methods one might
  52 likely want to override are: C<_table_pk_info>, C<_table_fk_info>, and
  53 C<_tables_list>.  See the included DBD drivers for examples of these.
  54
  55 =cut
  56
  57 1;