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

=head1 NAME

DBIx::Class::Manual::DocMap - What documentation do we have?

=head1 Manuals

=over 4

=item L<DBIx::Class::Manual> - User's Manual overview.

=item L<DBIx::Class::Manual::Intro> - Introduction to setting up and using DBIx::Class.

=item L<DBIx::Class::Manual::Example> - Full example Schema.

=item L<DBIx::Class::Manual::SQLHackers> - How to use DBIx::Class if you know SQL (external, available on CPAN)

=item L<DBIx::Class::Manual::Glossary> - What do all those terms mean?

=item L<DBIx::Class::Manual::Cookbook> - Various short recipes on how to do things.

=item L<DBIx::Class::Manual::FAQ> - Frequently Asked Questions, gathered from IRC and the mailing list.

=item L<DBIx::Class::Manual::Troubleshooting> - What to do if things go wrong (diagnostics of known error messages).

=back

=head1 Some essential reference documentation

The first two list items are the most important.

=over 4

=item L<DBIx::Class::ResultSet/search> - Selecting and manipulating sets.

=item L<DBIx::Class::$resultclass (normally based on DBIx::Class::Core)|DBIx::Class::Manual::ResultClass>
- Representing a single result (row) from a DB query. The methods inherited from
L<DBIx::Class::Row> and L<DBIx::Class::Relationship::Base> are used most often.

=item L<DBIx::Class::ResultSetColumn> - Perform operations on a single column of a ResultSet.

=item L<DBIx::Class::ResultSource> - Source/Table definition functions.

=item L<DBIx::Class::Schema> - Overall sourcess, and connection container.

=item L<DBIx::Class::Relationship> - Simple relationship declarations.

=item L<DBIx::Class::Relationship::Base> - Relationship declaration details.

=item L<DBIx::Class::InflateColumn> - Making objects out of your column values.

=back