Add optdep on CPAN::Uploader to get an effortless `make upload`
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Manual.pod
CommitLineData
8273e845 1=head1 NAME
9c82c181 2
bfab575a 3DBIx::Class::Manual - Index of the Manual
9c82c181 4
3b44ccc6 5=head1 DESCRIPTION
076652e8 6
8273e845 7This is the L<DBIx::Class> users manual. DBIx::Class is a SQL->OOP mapper.
076652e8 8This means that it can represent your SQL tables as perl classes, and give
9you convenient accessors and methods for retrieving and updating information
10from your SQL database.
11
12=head1 SECTIONS
13
afebe4ec 14=head2 L<DBIx::Class::Manual::FAQ>
15
16Short answers and doc pointers to questions.
17
92fcfd01 18=head2 L<DBIx::Class::Manual::Glossary>
19
20Explanations of terms used in this documentation.
21
8091aa91 22=head2 L<DBIx::Class::Manual::Intro>
076652e8 23
8273e845 24Beginner guide to using DBIx::Class.
076652e8 25
0a6876f9 26=head2 L<DBIx::Class::Manual::Example>
27
28An example of slightly more complex usage.
29
afebe4ec 30=head2 L<DBIx::Class::Manual::Joining>
31
32How to translate known SQL JOINs into DBIx-Class-ish.
33
8091aa91 34=head2 L<DBIx::Class::Manual::Cookbook>
076652e8 35
2ca930b4 36Convenient recipes for DBIC usage.
37
92fcfd01 38=head2 L<DBIx::Class::Manual::Reading>
39
40How to read (and write) the reference documentation.
41
2ca930b4 42=head2 L<DBIx::Class::Manual::DocMap>
43
44Lists of modules by task to help you find the correct document.
076652e8 45
8091aa91 46=head2 L<DBIx::Class::Manual::Troubleshooting>
076652e8 47
48Got trouble? Let us shoot it for you.
49
076652e8 50If you're using the CDBI Compat layer, we suggest reading the L<Class::DBI>
51documentation. It should behave the same way.
52
d444f9fa 53=head2 L<DBIx::Class::Manual::Component>
54
8273e845 55Existing components, and documentation and example on how to
d444f9fa 56develop new ones.
57
076652e8 58=cut
59