lib/DBIx/Class.pm

   1 package DBIx::Class;
   2
   3 use strict;
   4 use warnings;
   5
   6 use vars qw($VERSION);
   7 use base qw/DBIx::Class::Componentised Class::Data::Inheritable/;
   8
   9 $VERSION = '0.04001';
  10
  11
  12 1;
  13
  14 =head1 NAME
  15
  16 DBIx::Class - Extensible and flexible object <-> relational mapper.
  17
  18 =head1 SYNOPSIS
  19
  20 =head1 DESCRIPTION
  21
  22 This is an SQL to OO mapper, inspired by the L<Class::DBI> framework,
  23 and meant to support compability with it, while restructuring the
  24 internals and making it possible to support some new features like
  25 self-joins, distinct, group bys and more.
  26
  27 This project is still at an early stage, so the maintainers don't make
  28 any absolute promise that full backwards-compatibility will be supported;
  29 however, if we can without compromising the improvements we're trying to
  30 make, we will, and any non-compatible changes will merit a full justification
  31 on the mailing list and a CPAN developer release for people to test against.
  32
  33 The community can be found via -
  34
  35   Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
  36
  37   SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
  38
  39   Wiki: http://dbix-class.shadowcatsystems.co.uk/
  40
  41   IRC: irc.perl.org#dbix-class
  42
  43 =head1 QUICKSTART
  44
  45 If you're using L<Class::DBI>, and want an easy and fast way of migrating to
  46 DBIx::Class, take a look at L<DBIx::Class::CDBICompat>.
  47
  48 There are two ways of using DBIx::Class, the "simple" way and the "schema" way.
  49 The "simple" way of using DBIx::Class needs less classes than the "schema"
  50 way but doesn't give you the ability to easily use different database connections.
  51
  52 Some examples where different database connections are useful are:
  53
  54 different users with different rights
  55 different databases with the same schema.
  56
  57 =head1 Simple
  58
  59 First you need to create a base class which all other classes will inherit from.
  60 See L<DBIx::Class::DB> for information on how to do this.
  61
  62 Then you need to create a class for every table you want to use with DBIx::Class.
  63 See L<DBIx::Class::Table> for information on how to do this.
  64
  65 =head2 Schema
  66
  67 With this approach, the table classes inherit directly from DBIx::Class::Core,
  68 although it might be a good idea to create a "parent" class for all table
  69 classes that inherits from DBIx::Class::Core and adds additional methods
  70 needed by all table classes, e.g. reading a config file or loading auto primary
  71 key support.
  72
  73 Look at L<DBIx::Class::Schema> for information on how to do this.
  74
  75 If you need more help, check out the introduction in the
  76 manual below.
  77
  78 =head1 SEE ALSO
  79
  80 =head2 L<DBIx::Class::Core> - DBIC Core Classes
  81
  82 =head2 L<DBIx::Class::Manual> - User's manual
  83
  84 =head2 L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
  85
  86 =head2 L<DBIx::Class::DB> - database-level methods
  87
  88 =head2 L<DBIx::Class::Table> - table-level methods
  89
  90 =head2 L<DBIx::Class::Row> - row-level methods
  91
  92 =head2 L<DBIx::Class::PK> - primary key methods
  93
  94 =head2 L<DBIx::Class::Relationship> - relationships between tables
  95
  96 =head1 AUTHOR
  97
  98 Matt S. Trout <mst@shadowcatsystems.co.uk>
  99
 100 =head1 CONTRIBUTORS
 101
 102 Andy Grundman <andy@hybridized.org>
 103
 104 Brian Cassidy <bricas@cpan.org>
 105
 106 Dan Kubb <dan.kubb-cpan@onautopilot.com>
 107
 108 Dan Sully <daniel@cpan.org>
 109
 110 David Kamholz <dkamholz@cpan.org>
 111
 112 Jules Bean
 113
 114 Marcus Ramberg <mramberg@cpan.org>
 115
 116 Paul Makepeace
 117
 118 =head1 LICENSE
 119
 120 You may distribute this code under the same terms as Perl itself.
 121
 122 =cut
 123