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.08120_1';
32 $VERSION = eval $VERSION if $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:
61 =item * IRC: L<irc.perl.org#dbix-class (click for instant chatroom login)
62 |http://mibbit.com/chat/#dbix-class@irc.perl.org>
64 =item * Mailing list: L<http://lists.scsys.co.uk/mailman/listinfo/dbix-class>
66 =item * RT Bug Tracker: L<https://rt.cpan.org/Dist/Display.html?Queue=DBIx-Class>
68 =item * SVNWeb: L<http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/0.08>
70 =item * SVN: L<http://dev.catalyst.perl.org/repos/bast/DBIx-Class/0.08>
76 Create a schema class called MyDB/Schema.pm:
79 use base qw/DBIx::Class::Schema/;
81 __PACKAGE__->load_namespaces();
85 Create a result class to represent artists, who have many CDs, in
86 MyDB/Schema/Result/Artist.pm:
88 See L<DBIx::Class::ResultSource> for docs on defining result classes.
90 package MyDB::Schema::Result::Artist;
91 use base qw/DBIx::Class::Core/;
93 __PACKAGE__->table('artist');
94 __PACKAGE__->add_columns(qw/ artistid name /);
95 __PACKAGE__->set_primary_key('artistid');
96 __PACKAGE__->has_many(cds => 'MyDB::Schema::Result::CD');
100 A result class to represent a CD, which belongs to an artist, in
101 MyDB/Schema/Result/CD.pm:
103 package MyDB::Schema::Result::CD;
104 use base qw/DBIx::Class::Core/;
106 __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
107 __PACKAGE__->table('cd');
108 __PACKAGE__->add_columns(qw/ cdid artistid title year /);
109 __PACKAGE__->set_primary_key('cdid');
110 __PACKAGE__->belongs_to(artist => 'MyDB::Schema::Artist', 'artistid');
114 Then you can use these classes in your application's code:
116 # Connect to your database.
118 my $schema = MyDB::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params);
120 # Query for all artists and put them in an array,
121 # or retrieve them as a result set object.
122 # $schema->resultset returns a DBIx::Class::ResultSet
123 my @all_artists = $schema->resultset('Artist')->all;
124 my $all_artists_rs = $schema->resultset('Artist');
126 # Output all artists names
127 # $artist here is a DBIx::Class::Row, which has accessors
128 # for all its columns. Rows are also subclasses of your Result class.
129 foreach $artist (@all_artists) {
130 print $artist->name, "\n";
133 # Create a result set to search for artists.
134 # This does not query the DB.
135 my $johns_rs = $schema->resultset('Artist')->search(
136 # Build your WHERE using an SQL::Abstract structure:
137 { name => { like => 'John%' } }
140 # Execute a joined query to get the cds.
141 my @all_john_cds = $johns_rs->search_related('cds')->all;
143 # Fetch the next available row.
144 my $first_john = $johns_rs->next;
146 # Specify ORDER BY on the query.
147 my $first_john_cds_by_title_rs = $first_john->cds(
149 { order_by => 'title' }
152 # Create a result set that will fetch the artist data
153 # at the same time as it fetches CDs, using only one query.
154 my $millennium_cds_rs = $schema->resultset('CD')->search(
156 { prefetch => 'artist' }
159 my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
160 my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query
162 # new() makes a DBIx::Class::Row object but doesnt insert it into the DB.
163 # create() is the same as new() then insert().
164 my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
165 $new_cd->artist($cd->artist);
166 $new_cd->insert; # Auto-increment primary key filled in after INSERT
167 $new_cd->title('Fork');
169 $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
171 # change the year of all the millennium CDs at once
172 $millennium_cds_rs->update({ year => 2002 });
176 This is an SQL to OO mapper with an object API inspired by L<Class::DBI>
177 (with a compatibility layer as a springboard for porting) and a resultset API
178 that allows abstract encapsulation of database operations. It aims to make
179 representing queries in your code as perl-ish as possible while still
180 providing access to as many of the capabilities of the database as possible,
181 including retrieving related records from multiple tables in a single query,
182 JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and HAVING support.
184 DBIx::Class can handle multi-column primary and foreign keys, complex
185 queries and database-level paging, and does its best to only query the
186 database in order to return something you've directly asked for. If a
187 resultset is used as an iterator it only fetches rows off the statement
188 handle as requested in order to minimise memory usage. It has auto-increment
189 support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is
190 known to be used in production on at least the first four, and is fork-
191 and thread-safe out of the box (although your DBD may not be).
193 This project is still under rapid development, so large new features may be
194 marked EXPERIMENTAL - such APIs are still usable but may have edge bugs.
195 Failing test cases are *always* welcome and point releases are put out rapidly
196 as bugs are found and fixed.
198 We do our best to maintain full backwards compatibility for published
199 APIs, since DBIx::Class is used in production in many organisations,
200 and even backwards incompatible changes to non-published APIs will be fixed
201 if they're reported and doing so doesn't cost the codebase anything.
203 The test suite is quite substantial, and several developer releases
204 are generally made to CPAN before the branch for the next release is
205 merged back to trunk for a major release.
207 =head1 WHERE TO GO NEXT
209 L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
210 the modules where you will find documentation.
214 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
216 (I mostly consider myself "project founder" these days but the AUTHOR heading
221 abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
223 aherzog: Adam Herzog <adam@herzogdesigns.com>
225 andyg: Andy Grundman <andy@hybridized.org>
229 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
231 ash: Ash Berlin <ash@cpan.org>
233 bert: Norbert Csongradi <bert@cpan.org>
235 blblack: Brandon L. Black <blblack@gmail.com>
237 bluefeet: Aran Deltac <bluefeet@cpan.org>
239 boghead: Bryan Beeley <cpan@beeley.org>
241 bricas: Brian Cassidy <bricas@cpan.org>
243 brunov: Bruno Vecchi <vecchi.b@gmail.com>
245 caelum: Rafael Kitover <rkitover@cpan.org>
247 castaway: Jess Robinson
249 claco: Christopher H. Laco
253 da5id: David Jack Olrik <djo@cpan.org>
255 debolaz: Anders Nor Berle <berle@cpan.org>
257 dew: Dan Thomas <dan@godders.org>
259 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
261 dnm: Justin Wheeler <jwheeler@datademons.com>
263 dpetrov: Dimitar Petrov <mitakaa@gmail.com>
265 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
267 dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
269 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
271 goraxe: Gordon Irving <goraxe@cpan.org>
273 gphat: Cory G Watson <gphat@cpan.org>
275 groditi: Guillermo Roditi <groditi@cpan.org>
277 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
279 jasonmay: Jason May <jason.a.may@gmail.com>
283 jgoulah: John Goulah <jgoulah@cpan.org>
285 jguenther: Justin Guenther <jguenther@cpan.org>
287 jhannah: Jay Hannah <jay@jays.net>
289 jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
291 jon: Jon Schutz <jjschutz@cpan.org>
293 jshirley: J. Shirley <jshirley@gmail.com>
295 konobi: Scott McWhirter
297 lukes: Luke Saunders <luke.saunders@gmail.com>
299 marcus: Marcus Ramberg <mramberg@cpan.org>
301 mattlaw: Matt Lawrence
303 michaelr: Michael Reddick <michael.reddick@gmail.com>
305 ned: Neil de Carteret
307 nigel: Nigel Metheringham <nigelm@cpan.org>
309 ningu: David Kamholz <dkamholz@cpan.org>
311 Nniuq: Ron "Quinn" Straight" <quinnfazigu@gmail.org>
313 norbi: Norbert Buchmuller <norbi@nix.hu>
315 nuba: Nuba Princigalli <nuba@cpan.org>
317 Numa: Dan Sully <daniel@cpan.org>
319 ovid: Curtis "Ovid" Poe <ovid@cpan.org>
321 oyse: Øystein Torget <oystein.torget@dnv.com>
323 paulm: Paul Makepeace
325 penguin: K J Cheetham
327 perigrin: Chris Prather <chris@prather.org>
329 peter: Peter Collingbourne <peter@pcc.me.uk>
331 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
333 plu: Johannes Plunien <plu@cpan.org>
335 quicksilver: Jules Bean
337 rafl: Florian Ragwitz <rafl@debian.org>
339 rbuels: Robert Buels <rmb32@cornell.edu>
341 rdj: Ryan D Johnson <ryan@innerfence.com>
343 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
345 rjbs: Ricardo Signes <rjbs@cpan.org>
347 robkinyon: Rob Kinyon <rkinyon@cpan.org>
349 Roman: Roman Filippov <romanf@cpan.org>
351 sc_: Just Another Perl Hacker
353 scotty: Scotty Allen <scotty@scottyallen.com>
355 semifor: Marc Mims <marc@questright.com>
357 solomon: Jared Johnson <jaredj@nmgi.com>
359 spb: Stephen Bennett <stephen@freenode.net>
361 sszabo: Stephan Szabo <sszabo@bigpanda.com>
363 teejay : Aaron Trevena <teejay@cpan.org>
369 triode: Pete Gamache <gamache@cpan.org>
371 typester: Daisuke Murase <typester@cpan.org>
373 victori: Victor Igumnov <victori@cpan.org>
377 willert: Sebastian Willert <willert@cpan.org>
379 wreis: Wallace Reis <wreis@cpan.org>
381 zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
385 Copyright (c) 2005 - 2010 the DBIx::Class L</AUTHOR> and L</CONTRIBUTORS>
390 This library is free software and may be distributed under the same terms