Fixes, refactoring, test additions
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class.pm
CommitLineData
ea2e61bf 1package DBIx::Class;
2
5d283305 3use strict;
4use warnings;
5
5d283305 6use vars qw($VERSION);
227d4dee 7use base qw/DBIx::Class::Componentised/;
8
9$VERSION = '0.02';
10
126042ee 11
ea2e61bf 121;
34d52be2 13
14=head1 NAME
15
16DBIx::Class - Because the brain is a terrible thing to waste.
17
18=head1 SYNOPSIS
19
20=head1 DESCRIPTION
21
22This is a sql to oop mapper, inspired by the L<Class::DBI> framework,
23and meant to support compability with it, while restructuring the
24insides, and making it possible to support some new features like
25self-joins, distinct, group bys and more.
26
daec44b8 27It's currently considered EXPERIMENTAL - bring this near a production
28database at your own risk! The API is *not* fixed yet, although most of
29the primitives should be good for the future and any API changes will be
30posted to the mailing list before they're committed.
31
32The community can be found via -
33
34 Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
35
36 SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
37
38 Wiki: http://dbix-class.shadowcatsystems.co.uk/
39
40 IRC: irc.perl.org#dbix-class
41
39fe0e65 42=head1 QUICKSTART
43
44If you're using Class::DBI, replacing
45
daec44b8 46 use base qw/Class::DBI/;
39fe0e65 47
48with
49
daec44b8 50 use base qw/DBIx::Class/;
51 __PACKAGE__->load_components(qw/CDBICompat Core DB/);
39fe0e65 52
53will probably get you started.
54
55If you're using AUTO_INCREMENT for your primary columns, you'll also want
126042ee 56yo load the approriate PK::Auto subclass - e.g.
57
daec44b8 58 __PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core DB/);
126042ee 59
60(with is what ::Test::SQLite does to present the Class::DBI::Test::SQLite
61interface)
39fe0e65 62
63If you fancy playing around with DBIx::Class from scratch, then read the docs
64for ::Table and ::Relationship,
65
daec44b8 66 use base qw/DBIx::Class/;
67 __PACKAGE__->load_components(qw/Core DB/);
39fe0e65 68
69and have a look at t/lib/DBICTest.pm for a brief example.
70
34d52be2 71=head1 AUTHORS
72
daec44b8 73Matt S. Trout <mst@shadowcatsystems.co.uk>
34d52be2 74
75=head1 LICENSE
76
77You may distribute this code under the same terms as Perl itself.
78
79=cut
80