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.04';
  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 a sql to oop mapper, inspired by the L<Class::DBI> framework,
  23 and meant to support compability with it, while restructuring the
  24 insides, 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 Class::DBI, and want an easy and fast way of migrating to
  46 DBIx::Class look at L<DBIx::Class::CDBICompat>.
  47
  48 There are two ways of using DBIx::Class, the 'simple' and the 'schema' one.
  49
  50 The 'simple' way of using DBIx::Class needs less classes than the 'schema'
  51 way but doesn't give you the ability to use different database connections.
  52
  53 Some examples where different database connections are useful are:
  54
  55 different users with different rights
  56 different databases with the same schema.
  57
  58 =head1 Simple
  59
  60 First you need to create a base class all other classes inherit from.
  61
  62 Look at L<DBIx::Class::DB> how to do this
  63
  64 Next you need to create a class for every table you want to use with
  65 DBIx::Class.
  66
  67 Look at L<DBIx::Class::Table> how to do this.
  68
  69
  70 =head2 Schema
  71
  72 With this approach the table classes inherit directly from DBIx::Class::Core,
  73 although it might be a good idea to create a 'parent' class for all table
  74 classes which inherits from DBIx::Class::Core and adds additional methods
  75 needed by all table classes, e.g. reading a config file, loading auto primary
  76 key support.
  77
  78 Look at L<DBIx::Class::Schema> how to do this.
  79
  80 If you need more hand-holding, check out the introduction in the
  81 manual below.
  82
  83 =head1 SEE ALSO
  84
  85 =over 4
  86
  87 =item L<DBIx::Class::Core> - DBIC Core Classes
  88
  89 =item L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer.
  90
  91 =item L<DBIx::Class::Manual> - User's manual.
  92
  93 =back
  94
  95 =head1 AUTHOR
  96
  97 Matt S. Trout <mst@shadowcatsystems.co.uk>
  98
  99 =head1 CONTRIBUTORS
 100
 101 Andy Grundman <andy@hybridized.org>
 102
 103 Brian Cassidy <bricas@cpan.org>
 104
 105 Dan Kubb <dan.kubb-cpan@onautopilot.com>
 106
 107 Dan Sully <daniel@cpan.org>
 108
 109 davekam
 110
 111 Marcus Ramberg <mramberg@cpan.org>
 112
 113 =head1 LICENSE
 114
 115 You may distribute this code under the same terms as Perl itself.
 116
 117 =cut
 118