A fixed DBD::Firebird went to CPAN as well
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Manual / DocMap.pod
CommitLineData
7e2d47fc 1=head1 NAME
2
3DBIx::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
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
54e4be92 15=item L<DBIx::Class::Manual::SQLHackers> - How to use DBIx::Class if you know SQL (external, available on CPAN)
33eafbfd 16
17=item L<DBIx::Class::Manual::Glossary> - What do all those terms mean?
18
550a5cb0 19=item L<DBIx::Class::Manual::Cookbook> - Various short recipes on how to do things.
20
33eafbfd 21=item L<DBIx::Class::Manual::FAQ> - Frequently Asked Questions, gathered from IRC and the mailing list.
22
550a5cb0 23=item L<DBIx::Class::Manual::Troubleshooting> - What to do if things go wrong (diagnostics of known error messages).
24
550a5cb0 25=back
26
54e4be92 27=head1 Some essential reference documentation
550a5cb0 28
d71502bd 29The first two list items are the most important.
30
550a5cb0 31=over 4
32
d71502bd 33=item L<DBIx::Class::ResultSet/search> - Selecting and manipulating sets.
2ac88e5a 34
fc72869b 35The DSL (mini-language) for query composition is only partially explained there,
36see L<SQL::Abstract/WHERE CLAUSES> for the complete details.
37
d39311e4 38=item L<C<$schema>::Result::C<$resultclass>|DBIx::Class::Manual::ResultClass>
7fe2aec4 39- Classes representing a single result (row) from a DB query.
40
41Such classes normally subclass L<DBIx::Class::Core>, the methods inherited
42from L<DBIx::Class::Row|DBIx::Class::Row/METHODS> and
43L<DBIx::Class::Relationship::Base|DBIx::Class::Relationship::Base/METHODS>
44are used most often.
550a5cb0 45
54e4be92 46=item L<DBIx::Class::ResultSetColumn> - Perform operations on a single column of a ResultSet.
550a5cb0 47
54e4be92 48=item L<DBIx::Class::ResultSource> - Source/Table definition functions.
550a5cb0 49
4a0eed52 50=item L<DBIx::Class::Schema> - Overall sources, and connection container.
2ac88e5a 51
54e4be92 52=item L<DBIx::Class::Relationship> - Simple relationship declarations.
550a5cb0 53
54e4be92 54=item L<DBIx::Class::Relationship::Base> - Relationship declaration details.
85f78622 55
54e4be92 56=item L<DBIx::Class::InflateColumn> - Making objects out of your column values.
550a5cb0 57
7e2d47fc 58=back