described schema better, and added note about when you want to use it
[dbsrgits/DBIx-Class.git] / README
1 NAME
2     DBIx::Class - Extensible and flexible object <-> relational mapper.
3
4 SYNOPSIS
5 DESCRIPTION
6     This is a sql to oop mapper, inspired by the Class::DBI framework, and
7     meant to support compability with it, while restructuring the insides,
8     and making it possible to support some new features like self-joins,
9     distinct, group bys and more.
10
11     It's currently considered EXPERIMENTAL - bring this near a production
12     database at your own risk! The API is *not* fixed yet, although most of
13     the primitives should be good for the future and any API changes will be
14     posted to the mailing list before they're committed.
15
16     The community can be found via -
17
18       Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
19
20       SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
21
22       Wiki: http://dbix-class.shadowcatsystems.co.uk/
23
24       IRC: irc.perl.org#dbix-class
25
26 QUICKSTART
27     If you're using Class::DBI, replacing
28
29       use base qw/Class::DBI/;
30
31     with
32
33       use base qw/DBIx::Class/;
34       __PACKAGE__->load_components(qw/CDBICompat Core DB/);
35
36     will probably get you started.
37
38     If you're using AUTO_INCREMENT for your primary columns, you'll also
39     want yo load the approriate PK::Auto subclass - e.g.
40
41       __PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core DB/);
42
43     (with is what ::Test::SQLite does to present the
44     Class::DBI::Test::SQLite interface)
45
46     If you fancy playing around with DBIx::Class from scratch, then read the
47     docs for DBIx::Class::Table, ::Row, ::Schema, ::DB and ::Relationship,
48
49       use base qw/DBIx::Class/;
50       __PACKAGE__->load_components(qw/Core DB/);
51
52     and have a look at t/lib/DBICTest.pm for a brief example.
53
54 AUTHOR
55     Matt S. Trout <mst@shadowcatsystems.co.uk>
56
57 CONTRIBUTORS
58     Andy Grundman <andy@hybridized.org>
59
60     Brian Cassidy <bricas@cpan.org>
61
62     Dan Kubb <dan.kubb-cpan@onautopilot.com>
63
64     Dan Sully <daniel@cpan.org>
65
66     davekam
67
68     Marcus Ramberg <mramberg@cpan.org>
69
70 LICENSE
71     You may distribute this code under the same terms as Perl itself.
72