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