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 The DSL (mini-language) for query composition is only partially explained there,
  36 see L<SQL::Abstract/WHERE CLAUSES> for the complete details.
  37
  38 =item L< C<$schema>::Result::C<$resultclass>|DBIx::Class::Manual::ResultClass>
  39 - Classes representing a single result (row) from a DB query.
  40
  41 Such classes normally subclass L<DBIx::Class::Core>, the methods inherited
  42 from L<DBIx::Class::Row|DBIx::Class::Row/METHODS> and
  43 L<DBIx::Class::Relationship::Base|DBIx::Class::Relationship::Base/METHODS>
  44 are used most often.
  45
  46 =item L<DBIx::Class::ResultSetColumn> - Perform operations on a single column of a ResultSet.
  47
  48 =item L<DBIx::Class::ResultSource> - Source/Table definition functions.
  49
  50 =item L<DBIx::Class::Schema> - Overall sources, and connection container.
  51
  52 =item L<DBIx::Class::Relationship> - Simple relationship declarations.
  53
  54 =item L<DBIx::Class::Relationship::Base> - Relationship declaration details.
  55
  56 =item L<DBIx::Class::InflateColumn> - Making objects out of your column values.
  57
  58 =back