9 use DBIx::Class::Optional::Dependencies;
11 use vars qw($VERSION);
12 use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/;
13 use DBIx::Class::StartupCheck;
16 shift->mk_classaccessor(@_);
19 sub mk_classaccessor {
21 $self->mk_group_accessors('inherited', $_[0]);
22 $self->set_inherited(@_) if @_ > 1;
25 sub component_base_class { 'DBIx::Class' }
27 # Always remember to do all digits for the version even if they're 0
28 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
29 # brain damage and presumably various other packaging systems too
30 $VERSION = '0.08118_01';
32 $VERSION = eval $VERSION; # numify for warning-free dev releases
34 sub MODIFY_CODE_ATTRIBUTES {
35 my ($class,$code,@attrs) = @_;
36 $class->mk_classdata('__attr_cache' => {})
37 unless $class->can('__attr_cache');
38 $class->__attr_cache->{$code} = [@attrs];
44 my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {};
45 my $rest = eval { $self->next::method };
46 return $@ ? $cache : { %$cache, %$rest };
53 DBIx::Class - Extensible and flexible object <-> relational mapper.
55 =head1 GETTING HELP/SUPPORT
57 The community can be found via:
59 Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/
61 SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/
63 SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/
65 IRC: irc.perl.org#dbix-class
69 Create a schema class called MyDB/Schema.pm:
72 use base qw/DBIx::Class::Schema/;
74 __PACKAGE__->load_namespaces();
78 Create a result class to represent artists, who have many CDs, in
79 MyDB/Schema/Result/Artist.pm:
81 See L<DBIx::Class::ResultSource> for docs on defining result classes.
83 package MyDB::Schema::Result::Artist;
84 use base qw/DBIx::Class::Core/;
86 __PACKAGE__->table('artist');
87 __PACKAGE__->add_columns(qw/ artistid name /);
88 __PACKAGE__->set_primary_key('artistid');
89 __PACKAGE__->has_many(cds => 'MyDB::Schema::Result::CD');
93 A result class to represent a CD, which belongs to an artist, in
94 MyDB/Schema/Result/CD.pm:
96 package MyDB::Schema::Result::CD;
97 use base qw/DBIx::Class::Core/;
99 __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
100 __PACKAGE__->table('cd');
101 __PACKAGE__->add_columns(qw/ cdid artistid title year /);
102 __PACKAGE__->set_primary_key('cdid');
103 __PACKAGE__->belongs_to(artist => 'MyDB::Schema::Artist', 'artistid');
107 Then you can use these classes in your application's code:
109 # Connect to your database.
111 my $schema = MyDB::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params);
113 # Query for all artists and put them in an array,
114 # or retrieve them as a result set object.
115 # $schema->resultset returns a DBIx::Class::ResultSet
116 my @all_artists = $schema->resultset('Artist')->all;
117 my $all_artists_rs = $schema->resultset('Artist');
119 # Output all artists names
120 # $artist here is a DBIx::Class::Row, which has accessors
121 # for all its columns. Rows are also subclasses of your Result class.
122 foreach $artist (@all_artists) {
123 print $artist->name, "\n";
126 # Create a result set to search for artists.
127 # This does not query the DB.
128 my $johns_rs = $schema->resultset('Artist')->search(
129 # Build your WHERE using an SQL::Abstract structure:
130 { name => { like => 'John%' } }
133 # Execute a joined query to get the cds.
134 my @all_john_cds = $johns_rs->search_related('cds')->all;
136 # Fetch the next available row.
137 my $first_john = $johns_rs->next;
139 # Specify ORDER BY on the query.
140 my $first_john_cds_by_title_rs = $first_john->cds(
142 { order_by => 'title' }
145 # Create a result set that will fetch the artist data
146 # at the same time as it fetches CDs, using only one query.
147 my $millennium_cds_rs = $schema->resultset('CD')->search(
149 { prefetch => 'artist' }
152 my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
153 my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query
155 # new() makes a DBIx::Class::Row object but doesnt insert it into the DB.
156 # create() is the same as new() then insert().
157 my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
158 $new_cd->artist($cd->artist);
159 $new_cd->insert; # Auto-increment primary key filled in after INSERT
160 $new_cd->title('Fork');
162 $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
164 # change the year of all the millennium CDs at once
165 $millennium_cds_rs->update({ year => 2002 });
169 This is an SQL to OO mapper with an object API inspired by L<Class::DBI>
170 (with a compatibility layer as a springboard for porting) and a resultset API
171 that allows abstract encapsulation of database operations. It aims to make
172 representing queries in your code as perl-ish as possible while still
173 providing access to as many of the capabilities of the database as possible,
174 including retrieving related records from multiple tables in a single query,
175 JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and HAVING support.
177 DBIx::Class can handle multi-column primary and foreign keys, complex
178 queries and database-level paging, and does its best to only query the
179 database in order to return something you've directly asked for. If a
180 resultset is used as an iterator it only fetches rows off the statement
181 handle as requested in order to minimise memory usage. It has auto-increment
182 support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is
183 known to be used in production on at least the first four, and is fork-
184 and thread-safe out of the box (although your DBD may not be).
186 This project is still under rapid development, so large new features may be
187 marked EXPERIMENTAL - such APIs are still usable but may have edge bugs.
188 Failing test cases are *always* welcome and point releases are put out rapidly
189 as bugs are found and fixed.
191 We do our best to maintain full backwards compatibility for published
192 APIs, since DBIx::Class is used in production in many organisations,
193 and even backwards incompatible changes to non-published APIs will be fixed
194 if they're reported and doing so doesn't cost the codebase anything.
196 The test suite is quite substantial, and several developer releases
197 are generally made to CPAN before the branch for the next release is
198 merged back to trunk for a major release.
200 =head1 WHERE TO GO NEXT
202 L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
203 the modules where you will find documentation.
207 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
209 (I mostly consider myself "project founder" these days but the AUTHOR heading
214 abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
216 aherzog: Adam Herzog <adam@herzogdesigns.com>
218 andyg: Andy Grundman <andy@hybridized.org>
222 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
224 ash: Ash Berlin <ash@cpan.org>
226 bert: Norbert Csongradi <bert@cpan.org>
228 blblack: Brandon L. Black <blblack@gmail.com>
230 bluefeet: Aran Deltac <bluefeet@cpan.org>
232 boghead: Bryan Beeley <cpan@beeley.org>
234 bricas: Brian Cassidy <bricas@cpan.org>
236 brunov: Bruno Vecchi <vecchi.b@gmail.com>
238 caelum: Rafael Kitover <rkitover@cpan.org>
240 castaway: Jess Robinson
242 claco: Christopher H. Laco
246 da5id: David Jack Olrik <djo@cpan.org>
248 debolaz: Anders Nor Berle <berle@cpan.org>
250 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
252 dnm: Justin Wheeler <jwheeler@datademons.com>
254 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
256 dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
258 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
260 gphat: Cory G Watson <gphat@cpan.org>
262 groditi: Guillermo Roditi <groditi@cpan.org>
264 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
266 jasonmay: Jason May <jason.a.may@gmail.com>
270 jgoulah: John Goulah <jgoulah@cpan.org>
272 jguenther: Justin Guenther <jguenther@cpan.org>
274 jhannah: Jay Hannah <jay@jays.net>
276 jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
278 jon: Jon Schutz <jjschutz@cpan.org>
280 jshirley: J. Shirley <jshirley@gmail.com>
282 konobi: Scott McWhirter
284 lukes: Luke Saunders <luke.saunders@gmail.com>
286 marcus: Marcus Ramberg <mramberg@cpan.org>
288 mattlaw: Matt Lawrence
290 michaelr: Michael Reddick <michael.reddick@gmail.com>
292 ned: Neil de Carteret
294 nigel: Nigel Metheringham <nigelm@cpan.org>
296 ningu: David Kamholz <dkamholz@cpan.org>
298 Nniuq: Ron "Quinn" Straight" <quinnfazigu@gmail.org>
300 norbi: Norbert Buchmuller <norbi@nix.hu>
302 Numa: Dan Sully <daniel@cpan.org>
304 ovid: Curtis "Ovid" Poe <ovid@cpan.org>
306 oyse: Øystein Torget <oystein.torget@dnv.com>
308 paulm: Paul Makepeace
310 penguin: K J Cheetham
312 perigrin: Chris Prather <chris@prather.org>
314 peter: Peter Collingbourne <peter@pcc.me.uk>
316 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
318 plu: Johannes Plunien <plu@cpan.org>
320 quicksilver: Jules Bean
322 rafl: Florian Ragwitz <rafl@debian.org>
324 rbuels: Robert Buels <rmb32@cornell.edu>
326 rdj: Ryan D Johnson <ryan@innerfence.com>
328 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
330 rjbs: Ricardo Signes <rjbs@cpan.org>
332 robkinyon: Rob Kinyon <rkinyon@cpan.org>
334 Roman: Roman Filippov <romanf@cpan.org>
336 sc_: Just Another Perl Hacker
338 scotty: Scotty Allen <scotty@scottyallen.com>
340 semifor: Marc Mims <marc@questright.com>
342 solomon: Jared Johnson <jaredj@nmgi.com>
344 spb: Stephen Bennett <stephen@freenode.net>
346 sszabo: Stephan Szabo <sszabo@bigpanda.com>
348 teejay : Aaron Trevena <teejay@cpan.org>
354 triode: Pete Gamache <gamache@cpan.org>
356 typester: Daisuke Murase <typester@cpan.org>
358 victori: Victor Igumnov <victori@cpan.org>
362 willert: Sebastian Willert <willert@cpan.org>
364 wreis: Wallace Reis <wreis@cpan.org>
366 zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
370 Copyright (c) 2005 - 2009 the DBIx::Class L</AUTHOR> and L</CONTRIBUTORS>
375 This library is free software and may be distributed under the same terms