lib/DBIx/Class.pm

   1 package DBIx::Class;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base qw/DBIx::Class::CDBICompat DBIx::Class::Core/;
   7
   8 use vars qw($VERSION);
   9
  10 $VERSION = '0.01';
  11
  12 1;
  13
  14 =head1 NAME
  15
  16 DBIx::Class - Because the brain is a terrible thing to waste.
  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 =head1 QUICKSTART
  28
  29 If you're using Class::DBI, replacing
  30
  31 use base qw/Class::DBI/;
  32
  33 with
  34
  35 use base qw/DBIx::Class::CDBICompat DBIx::Class::Core/;
  36
  37 will probably get you started.
  38
  39 If you're using AUTO_INCREMENT for your primary columns, you'll also want
  40 PK::Auto and an appropriate PK::Auto::DBName (e.g. ::SQLite).
  41
  42 If you fancy playing around with DBIx::Class from scratch, then read the docs
  43 for ::Table and ::Relationship,
  44
  45 use base qw/DBIx::Class/;
  46
  47 and have a look at t/lib/DBICTest.pm for a brief example.
  48
  49 =head1 AUTHORS
  50
  51 Matt S. Trout <perl-stuff@trout.me.uk>
  52
  53 =head1 LICENSE
  54
  55 You may distribute this code under the same terms as Perl itself.
  56
  57 =cut
  58