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
199 L<your DBD may not be|DBI/Threads_and_Thread_Safety>).
201 This project is still under rapid development, so large new features may be
202 marked EXPERIMENTAL - such APIs are still usable but may have edge bugs.
203 Failing test cases are *always* welcome and point releases are put out rapidly
204 as bugs are found and fixed.
206 We do our best to maintain full backwards compatibility for published
207 APIs, since DBIx::Class is used in production in many organisations,
208 and even backwards incompatible changes to non-published APIs will be fixed
209 if they're reported and doing so doesn't cost the codebase anything.
211 The test suite is quite substantial, and several developer releases
212 are generally made to CPAN before the branch for the next release is
213 merged back to trunk for a major release.
215 =head1 WHERE TO GO NEXT
217 L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
218 the modules where you will find documentation.
222 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
224 (I mostly consider myself "project founder" these days but the AUTHOR heading
229 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
231 aherzog: Adam Herzog <adam@herzogdesigns.com>
233 Alexander Keusch <cpan@keusch.at>
235 amiri: Amiri Barksdale <amiri@metalabel.com>
237 amoore: Andrew Moore <amoore@cpan.org>
239 andyg: Andy Grundman <andy@hybridized.org>
243 arc: Aaron Crane <arc@cpan.org>
245 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
247 ash: Ash Berlin <ash@cpan.org>
249 bert: Norbert Csongradi <bert@cpan.org>
251 blblack: Brandon L. Black <blblack@gmail.com>
253 bluefeet: Aran Deltac <bluefeet@cpan.org>
255 boghead: Bryan Beeley <cpan@beeley.org>
257 bricas: Brian Cassidy <bricas@cpan.org>
259 brunov: Bruno Vecchi <vecchi.b@gmail.com>
261 caelum: Rafael Kitover <rkitover@cpan.org>
263 castaway: Jess Robinson
265 claco: Christopher H. Laco
269 da5id: David Jack Olrik <djo@cpan.org>
271 debolaz: Anders Nor Berle <berle@cpan.org>
273 dew: Dan Thomas <dan@godders.org>
275 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
277 dnm: Justin Wheeler <jwheeler@datademons.com>
279 dpetrov: Dimitar Petrov <mitakaa@gmail.com>
281 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
283 dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
285 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
287 goraxe: Gordon Irving <goraxe@cpan.org>
289 gphat: Cory G Watson <gphat@cpan.org>
291 groditi: Guillermo Roditi <groditi@cpan.org>
293 Haarg: Graham Knop <haarg@haarg.org>
295 hobbs: Andrew Rodland <arodland@cpan.org>
297 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
299 initself: Mike Baas <mike@initselftech.com>
301 jasonmay: Jason May <jason.a.may@gmail.com>
305 jgoulah: John Goulah <jgoulah@cpan.org>
307 jguenther: Justin Guenther <jguenther@cpan.org>
309 jhannah: Jay Hannah <jay@jays.net>
311 jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
313 jon: Jon Schutz <jjschutz@cpan.org>
315 jshirley: J. Shirley <jshirley@gmail.com>
317 konobi: Scott McWhirter
319 lukes: Luke Saunders <luke.saunders@gmail.com>
321 marcus: Marcus Ramberg <mramberg@cpan.org>
323 mattlaw: Matt Lawrence
325 michaelr: Michael Reddick <michael.reddick@gmail.com>
327 ned: Neil de Carteret
329 nigel: Nigel Metheringham <nigelm@cpan.org>
331 ningu: David Kamholz <dkamholz@cpan.org>
333 Nniuq: Ron "Quinn" Straight" <quinnfazigu@gmail.org>
335 norbi: Norbert Buchmuller <norbi@nix.hu>
337 nuba: Nuba Princigalli <nuba@cpan.org>
339 Numa: Dan Sully <daniel@cpan.org>
341 ovid: Curtis "Ovid" Poe <ovid@cpan.org>
343 oyse: Øystein Torget <oystein.torget@dnv.com>
345 paulm: Paul Makepeace
347 penguin: K J Cheetham
349 perigrin: Chris Prather <chris@prather.org>
351 peter: Peter Collingbourne <peter@pcc.me.uk>
353 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
355 plu: Johannes Plunien <plu@cpan.org>
357 Possum: Daniel LeWarne <possum@cpan.org>
359 quicksilver: Jules Bean
361 rafl: Florian Ragwitz <rafl@debian.org>
363 rainboxx: Matthias Dietrich <perl@rb.ly>
365 rbo: Robert Bohne <rbo@cpan.org>
367 rbuels: Robert Buels <rmb32@cornell.edu>
369 rdj: Ryan D Johnson <ryan@innerfence.com>
371 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
373 rjbs: Ricardo Signes <rjbs@cpan.org>
375 robkinyon: Rob Kinyon <rkinyon@cpan.org>
377 Roman: Roman Filippov <romanf@cpan.org>
379 sc_: Just Another Perl Hacker
381 scotty: Scotty Allen <scotty@scottyallen.com>
383 semifor: Marc Mims <marc@questright.com>
385 solomon: Jared Johnson <jaredj@nmgi.com>
387 spb: Stephen Bennett <stephen@freenode.net>
389 sszabo: Stephan Szabo <sszabo@bigpanda.com>
391 teejay : Aaron Trevena <teejay@cpan.org>
397 tonvoon: Ton Voon <tonvoon@cpan.org>
399 triode: Pete Gamache <gamache@cpan.org>
401 typester: Daisuke Murase <typester@cpan.org>
403 victori: Victor Igumnov <victori@cpan.org>
407 willert: Sebastian Willert <willert@cpan.org>
409 wreis: Wallace Reis <wreis@cpan.org>
411 yrlnry: Mark Jason Dominus <mjd@plover.com>
413 zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
417 Copyright (c) 2005 - 2010 the DBIx::Class L</AUTHOR> and L</CONTRIBUTORS>
422 This library is free software and may be distributed under the same terms