Commit | Line | Data |
7e2d47fc |
1 | =head1 NAME |
2 | |
3 | DBIx::Class::Manual::DocMap - What documentation do we have? |
550a5cb0 |
4 | |
5 | =head1 Manuals |
6 | |
7 | =over 4 |
8 | |
9 | =item L<DBIx::Class::Manual> - User's Manual overview. |
10 | |
44a8c0da |
11 | =item L<DBIx::Class::Manual::QuickStart> - Up and running with DBIC in 10 minutes. |
550a5cb0 |
12 | |
44a8c0da |
13 | =item L<DBIx::Class::Manual::Intro> - More detailed introduction to setting up and using DBIx::Class. |
550a5cb0 |
14 | |
54e4be92 |
15 | =item L<DBIx::Class::Manual::SQLHackers> - How to use DBIx::Class if you know SQL (external, available on CPAN) |
33eafbfd |
16 | |
dc194fb9 |
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 | |
33eafbfd |
21 | =item L<DBIx::Class::Manual::Glossary> - What do all those terms mean? |
22 | |
550a5cb0 |
23 | =item L<DBIx::Class::Manual::Cookbook> - Various short recipes on how to do things. |
24 | |
33eafbfd |
25 | =item L<DBIx::Class::Manual::FAQ> - Frequently Asked Questions, gathered from IRC and the mailing list. |
26 | |
550a5cb0 |
27 | =item L<DBIx::Class::Manual::Troubleshooting> - What to do if things go wrong (diagnostics of known error messages). |
28 | |
550a5cb0 |
29 | =back |
30 | |
54e4be92 |
31 | =head1 Some essential reference documentation |
550a5cb0 |
32 | |
d71502bd |
33 | The first two list items are the most important. |
34 | |
550a5cb0 |
35 | =over 4 |
36 | |
d71502bd |
37 | =item L<DBIx::Class::ResultSet/search> - Selecting and manipulating sets. |
2ac88e5a |
38 | |
fc72869b |
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 | |
d39311e4 |
42 | =item L<C<$schema>::Result::C<$resultclass>|DBIx::Class::Manual::ResultClass> |
7fe2aec4 |
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. |
550a5cb0 |
49 | |
54e4be92 |
50 | =item L<DBIx::Class::ResultSetColumn> - Perform operations on a single column of a ResultSet. |
550a5cb0 |
51 | |
54e4be92 |
52 | =item L<DBIx::Class::ResultSource> - Source/Table definition functions. |
550a5cb0 |
53 | |
4a0eed52 |
54 | =item L<DBIx::Class::Schema> - Overall sources, and connection container. |
2ac88e5a |
55 | |
54e4be92 |
56 | =item L<DBIx::Class::Relationship> - Simple relationship declarations. |
550a5cb0 |
57 | |
54e4be92 |
58 | =item L<DBIx::Class::Relationship::Base> - Relationship declaration details. |
85f78622 |
59 | |
54e4be92 |
60 | =item L<DBIx::Class::InflateColumn> - Making objects out of your column values. |
550a5cb0 |
61 | |
7e2d47fc |
62 | =back |
a2bd3796 |
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 | |