point out where in the docs a user is most likely to spend reading time
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Manual / DocMap.pod
1 =head1 NAME
2
3 DBIx::Class::Manual::DocMap - What documentation do we have?
4
5 =head1 Manuals
6
7 =over 4
8
9 =item L<DBIx::Class::Manual> - User's Manual overview.
10
11 =item L<DBIx::Class::Manual::Intro> - Introduction to setting up and using DBIx::Class.
12
13 =item L<DBIx::Class::Manual::Example> - Full example Schema.
14
15 =item L<DBIx::Class::Manual::SQLHackers> - How to use DBIx::Class if you know SQL (external, available on CPAN)
16
17 =item L<DBIx::Class::Manual::Glossary> - What do all those terms mean?
18
19 =item L<DBIx::Class::Manual::Cookbook> - Various short recipes on how to do things.
20
21 =item L<DBIx::Class::Manual::FAQ> - Frequently Asked Questions, gathered from IRC and the mailing list.
22
23 =item L<DBIx::Class::Manual::Troubleshooting> - What to do if things go wrong (diagnostics of known error messages).
24
25 =back
26
27 =head1 Some essential reference documentation
28
29 The first two list items are the most important.
30
31 =over 4
32
33 =item L<DBIx::Class::ResultSet/search> - Selecting and manipulating sets.
34
35 =item L<DBIx::Class::$resultclass (normally based on DBIx::Class::Core)|DBIx::Class::Manual::ResultClass>
36 - Representing a single result (row) from a DB query. The methods inherited from
37 L<DBIx::Class::Row> and L<DBIx::Class::Relationship::Base> are used most often.
38
39 =item L<DBIx::Class::ResultSetColumn> - Perform operations on a single column of a ResultSet.
40
41 =item L<DBIx::Class::ResultSource> - Source/Table definition functions.
42
43 =item L<DBIx::Class::Schema> - Overall sourcess, and connection container.
44
45 =item L<DBIx::Class::Relationship> - Simple relationship declarations.
46
47 =item L<DBIx::Class::Relationship::Base> - Relationship declaration details.
48
49 =item L<DBIx::Class::InflateColumn> - Making objects out of your column values.
50
51 =back