- Add synopsis
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Core.pm
1 package DBIx::Class::Core;
2
3 use strict;
4 use warnings;
5 no warnings 'qw';
6
7 use base qw/DBIx::Class/;
8
9 __PACKAGE__->load_components(qw/
10   InflateColumn
11   Relationship
12   PK
13   Row
14   TableInstance
15   Exception
16   AccessorGroup/);
17
18 1;
19
20 =head1 NAME 
21
22 DBIx::Class::Core - Core set of DBIx::Class modules
23
24 =head1 SYNOPSIS
25
26   # In your table classes
27   __PACKAGE__->load_components(qw/Core/);
28
29 =head1 DESCRIPTION
30
31 This class just inherits from the various modules that make up the
32 L<DBIx::Class> core features.  You almost certainly want these.
33
34 The core modules currently are:
35
36 =over 4
37
38 =item L<DBIx::Class::InflateColumn>
39
40 =item L<DBIx::Class::Relationship>
41
42 =item L<DBIx::Class::PK>
43
44 =item L<DBIx::Class::Row>
45
46 =item L<DBIx::Class::TableInstance>
47
48 =item L<DBIx::Class::Exception>
49
50 =item L<DBIx::Class::AccessorGroup>
51
52 =back
53
54 If you are also using a L<DBIx::Class::PK::Auto> component, please
55 make sure you load it correctly. Refer to
56 L<DBIx::Class::PK::Auto/DESCRIPTION> for more information.
57
58 =head1 AUTHORS
59
60 Matt S. Trout <mst@shadowcatsystems.co.uk>
61
62 =head1 LICENSE
63
64 You may distribute this code under the same terms as Perl itself.
65
66 =cut