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
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 : {};
48 %{ $self->maybe::next::method || {} },
56 DBIx::Class - Extensible and flexible object <-> relational mapper.
58 =head1 GETTING HELP/SUPPORT
60 The community can be found via:
64 =item * IRC: irc.perl.org#dbix-class
67 <a href="http://chat.mibbit.com/#dbix-class@irc.perl.org">(click for instant chatroom login)</a>
69 =item * Mailing list: L<http://lists.scsys.co.uk/mailman/listinfo/dbix-class>
71 =item * RT Bug Tracker: L<https://rt.cpan.org/Dist/Display.html?Queue=DBIx-Class>
73 =item * gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git>
75 =item * git: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git>
77 =item * twitter L<http://www.twitter.com/dbix_class>
83 Create a schema class called MyDB/Schema.pm:
86 use base qw/DBIx::Class::Schema/;
88 __PACKAGE__->load_namespaces();
92 Create a result class to represent artists, who have many CDs, in
93 MyDB/Schema/Result/Artist.pm:
95 See L<DBIx::Class::ResultSource> for docs on defining result classes.
97 package MyDB::Schema::Result::Artist;
98 use base qw/DBIx::Class::Core/;
100 __PACKAGE__->table('artist');
101 __PACKAGE__->add_columns(qw/ artistid name /);
102 __PACKAGE__->set_primary_key('artistid');
103 __PACKAGE__->has_many(cds => 'MyDB::Schema::Result::CD');
107 A result class to represent a CD, which belongs to an artist, in
108 MyDB/Schema/Result/CD.pm:
110 package MyDB::Schema::Result::CD;
111 use base qw/DBIx::Class::Core/;
113 __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
114 __PACKAGE__->table('cd');
115 __PACKAGE__->add_columns(qw/ cdid artistid title year /);
116 __PACKAGE__->set_primary_key('cdid');
117 __PACKAGE__->belongs_to(artist => 'MyDB::Schema::Artist', 'artistid');
121 Then you can use these classes in your application's code:
123 # Connect to your database.
125 my $schema = MyDB::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params);
127 # Query for all artists and put them in an array,
128 # or retrieve them as a result set object.
129 # $schema->resultset returns a DBIx::Class::ResultSet
130 my @all_artists = $schema->resultset('Artist')->all;
131 my $all_artists_rs = $schema->resultset('Artist');
133 # Output all artists names
134 # $artist here is a DBIx::Class::Row, which has accessors
135 # for all its columns. Rows are also subclasses of your Result class.
136 foreach $artist (@all_artists) {
137 print $artist->name, "\n";
140 # Create a result set to search for artists.
141 # This does not query the DB.
142 my $johns_rs = $schema->resultset('Artist')->search(
143 # Build your WHERE using an SQL::Abstract structure:
144 { name => { like => 'John%' } }
147 # Execute a joined query to get the cds.
148 my @all_john_cds = $johns_rs->search_related('cds')->all;
150 # Fetch the next available row.
151 my $first_john = $johns_rs->next;
153 # Specify ORDER BY on the query.
154 my $first_john_cds_by_title_rs = $first_john->cds(
156 { order_by => 'title' }
159 # Create a result set that will fetch the artist data
160 # at the same time as it fetches CDs, using only one query.
161 my $millennium_cds_rs = $schema->resultset('CD')->search(
163 { prefetch => 'artist' }
166 my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
167 my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query
169 # new() makes a DBIx::Class::Row object but doesnt insert it into the DB.
170 # create() is the same as new() then insert().
171 my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
172 $new_cd->artist($cd->artist);
173 $new_cd->insert; # Auto-increment primary key filled in after INSERT
174 $new_cd->title('Fork');
176 $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
178 # change the year of all the millennium CDs at once
179 $millennium_cds_rs->update({ year => 2002 });
183 This is an SQL to OO mapper with an object API inspired by L<Class::DBI>
184 (with a compatibility layer as a springboard for porting) and a resultset API
185 that allows abstract encapsulation of database operations. It aims to make
186 representing queries in your code as perl-ish as possible while still
187 providing access to as many of the capabilities of the database as possible,
188 including retrieving related records from multiple tables in a single query,
189 JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and HAVING support.
191 DBIx::Class can handle multi-column primary and foreign keys, complex
192 queries and database-level paging, and does its best to only query the
193 database in order to return something you've directly asked for. If a
194 resultset is used as an iterator it only fetches rows off the statement
195 handle as requested in order to minimise memory usage. It has auto-increment
196 support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is
197 known to be used in production on at least the first four, and is fork-
198 and thread-safe out of the box (although your DBD may not be).
200 This project is still under rapid development, so large new features may be
201 marked EXPERIMENTAL - such APIs are still usable but may have edge bugs.
202 Failing test cases are *always* welcome and point releases are put out rapidly
203 as bugs are found and fixed.
205 We do our best to maintain full backwards compatibility for published
206 APIs, since DBIx::Class is used in production in many organisations,
207 and even backwards incompatible changes to non-published APIs will be fixed
208 if they're reported and doing so doesn't cost the codebase anything.
210 The test suite is quite substantial, and several developer releases
211 are generally made to CPAN before the branch for the next release is
212 merged back to trunk for a major release.
214 =head1 WHERE TO GO NEXT
216 L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
217 the modules where you will find documentation.
221 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
223 (I mostly consider myself "project founder" these days but the AUTHOR heading
228 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
230 aherzog: Adam Herzog <adam@herzogdesigns.com>
232 Alexander Keusch <cpan@keusch.at>
234 amiri: Amiri Barksdale <amiri@metalabel.com>
236 amoore: Andrew Moore <amoore@cpan.org>
238 andyg: Andy Grundman <andy@hybridized.org>
242 arc: Aaron Crane <arc@cpan.org>
244 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
246 ash: Ash Berlin <ash@cpan.org>
248 bert: Norbert Csongradi <bert@cpan.org>
250 blblack: Brandon L. Black <blblack@gmail.com>
252 bluefeet: Aran Deltac <bluefeet@cpan.org>
254 boghead: Bryan Beeley <cpan@beeley.org>
256 bricas: Brian Cassidy <bricas@cpan.org>
258 brunov: Bruno Vecchi <vecchi.b@gmail.com>
260 caelum: Rafael Kitover <rkitover@cpan.org>
262 castaway: Jess Robinson
264 claco: Christopher H. Laco
268 da5id: David Jack Olrik <djo@cpan.org>
270 debolaz: Anders Nor Berle <berle@cpan.org>
272 dew: Dan Thomas <dan@godders.org>
274 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
276 dnm: Justin Wheeler <jwheeler@datademons.com>
278 dpetrov: Dimitar Petrov <mitakaa@gmail.com>
280 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
282 dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
284 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
286 goraxe: Gordon Irving <goraxe@cpan.org>
288 gphat: Cory G Watson <gphat@cpan.org>
290 groditi: Guillermo Roditi <groditi@cpan.org>
292 Haarg: Graham Knop <haarg@haarg.org>
294 hobbs: Andrew Rodland <arodland@cpan.org>
296 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
298 initself: Mike Baas <mike@initselftech.com>
300 jasonmay: Jason May <jason.a.may@gmail.com>
304 jgoulah: John Goulah <jgoulah@cpan.org>
306 jguenther: Justin Guenther <jguenther@cpan.org>
308 jhannah: Jay Hannah <jay@jays.net>
310 jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
312 jon: Jon Schutz <jjschutz@cpan.org>
314 jshirley: J. Shirley <jshirley@gmail.com>
316 konobi: Scott McWhirter
318 lukes: Luke Saunders <luke.saunders@gmail.com>
320 marcus: Marcus Ramberg <mramberg@cpan.org>
322 mattlaw: Matt Lawrence
324 michaelr: Michael Reddick <michael.reddick@gmail.com>
326 ned: Neil de Carteret
328 nigel: Nigel Metheringham <nigelm@cpan.org>
330 ningu: David Kamholz <dkamholz@cpan.org>
332 Nniuq: Ron "Quinn" Straight" <quinnfazigu@gmail.org>
334 norbi: Norbert Buchmuller <norbi@nix.hu>
336 nuba: Nuba Princigalli <nuba@cpan.org>
338 Numa: Dan Sully <daniel@cpan.org>
340 ovid: Curtis "Ovid" Poe <ovid@cpan.org>
342 oyse: Øystein Torget <oystein.torget@dnv.com>
344 paulm: Paul Makepeace
346 penguin: K J Cheetham
348 perigrin: Chris Prather <chris@prather.org>
350 peter: Peter Collingbourne <peter@pcc.me.uk>
352 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
354 plu: Johannes Plunien <plu@cpan.org>
356 Possum: Daniel LeWarne <possum@cpan.org>
358 quicksilver: Jules Bean
360 rafl: Florian Ragwitz <rafl@debian.org>
362 rainboxx: Matthias Dietrich <perl@rb.ly>
364 rbo: Robert Bohne <rbo@cpan.org>
366 rbuels: Robert Buels <rmb32@cornell.edu>
368 rdj: Ryan D Johnson <ryan@innerfence.com>
370 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
372 rjbs: Ricardo Signes <rjbs@cpan.org>
374 robkinyon: Rob Kinyon <rkinyon@cpan.org>
376 Roman: Roman Filippov <romanf@cpan.org>
378 sc_: Just Another Perl Hacker
380 scotty: Scotty Allen <scotty@scottyallen.com>
382 semifor: Marc Mims <marc@questright.com>
384 solomon: Jared Johnson <jaredj@nmgi.com>
386 spb: Stephen Bennett <stephen@freenode.net>
388 sszabo: Stephan Szabo <sszabo@bigpanda.com>
390 teejay : Aaron Trevena <teejay@cpan.org>
396 tonvoon: Ton Voon <tonvoon@cpan.org>
398 triode: Pete Gamache <gamache@cpan.org>
400 typester: Daisuke Murase <typester@cpan.org>
402 victori: Victor Igumnov <victori@cpan.org>
406 willert: Sebastian Willert <willert@cpan.org>
408 wreis: Wallace Reis <wreis@cpan.org>
410 yrlnry: Mark Jason Dominus <mjd@plover.com>
412 zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
416 Copyright (c) 2005 - 2010 the DBIx::Class L</AUTHOR> and L</CONTRIBUTORS>
421 This library is free software and may be distributed under the same terms