Examples and documentation update and cleanup
[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::QuickStart> - Up and running with DBIC in 10 minutes.
12
13 =item L<DBIx::Class::Manual::Intro> - More detailed introduction to setting up and using DBIx::Class.
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::Joining> - Joining tables with DBIx::Class.
18
19 =item L<DBIx::Class::Manual::Features> - A boatload of DBIx::Class features with links to respective documentation.
20
21 =item L<DBIx::Class::Manual::Glossary> - What do all those terms mean?
22
23 =item L<DBIx::Class::Manual::Cookbook> - Various short recipes on how to do things.
24
25 =item L<DBIx::Class::Manual::FAQ> - Frequently Asked Questions, gathered from IRC and the mailing list.
26
27 =item L<DBIx::Class::Manual::Troubleshooting> - What to do if things go wrong (diagnostics of known error messages).
28
29 =back
30
31 =head1 Some essential reference documentation
32
33 The first two list items are the most important.
34
35 =over 4
36
37 =item L<DBIx::Class::ResultSet/search> - Selecting and manipulating sets.
38
39 The DSL (mini-language) for query composition is only partially explained there,
40 see L<SQL::Abstract/WHERE CLAUSES> for the complete details.
41
42 =item L<C<$schema>::Result::C<$resultclass>|DBIx::Class::Manual::ResultClass>
43 - Classes representing a single result (row) from a DB query.
44
45 Such classes normally subclass L<DBIx::Class::Core>, the methods inherited
46 from L<DBIx::Class::Row|DBIx::Class::Row/METHODS> and
47 L<DBIx::Class::Relationship::Base|DBIx::Class::Relationship::Base/METHODS>
48 are used most often.
49
50 =item L<DBIx::Class::ResultSetColumn> - Perform operations on a single column of a ResultSet.
51
52 =item L<DBIx::Class::ResultSource> - Source/Table definition functions.
53
54 =item L<DBIx::Class::Schema> - Overall sources, and connection container.
55
56 =item L<DBIx::Class::Relationship> - Simple relationship declarations.
57
58 =item L<DBIx::Class::Relationship::Base> - Relationship declaration details.
59
60 =item L<DBIx::Class::InflateColumn> - Making objects out of your column values.
61
62 =back
63
64 =head1 FURTHER QUESTIONS?
65
66 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
67
68 =head1 COPYRIGHT AND LICENSE
69
70 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
71 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
72 redistribute it and/or modify it under the same terms as the
73 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
74