lib/DBIx/Class.pm

   1 package DBIx::Class;
   2
   3 use strict;
   4 use warnings;
   5
   6 use vars qw($VERSION);
   7 use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/;
   8 use DBIx::Class::StartupCheck;
   9
  10
  11 sub mk_classdata {
  12   shift->mk_classaccessor(@_);
  13 }
  14
  15 sub mk_classaccessor {
  16   my $self = shift;
  17   $self->mk_group_accessors('inherited', $_[0]);
  18   $self->set_inherited(@_) if @_ > 1;
  19 }
  20
  21 sub component_base_class { 'DBIx::Class' }
  22
  23 # Always remember to do all digits for the version even if they're 0
  24 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
  25 # brain damage and presumably various other packaging systems too
  26
  27 $VERSION = '0.08099_07';
  28
  29 $VERSION = eval $VERSION; # numify for warning-free dev releases
  30
  31 sub MODIFY_CODE_ATTRIBUTES {
  32   my ($class,$code,@attrs) = @_;
  33   $class->mk_classdata('__attr_cache' => {})
  34     unless $class->can('__attr_cache');
  35   $class->__attr_cache->{$code} = [@attrs];
  36   return ();
  37 }
  38
  39 sub _attr_cache {
  40   my $self = shift;
  41   my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {};
  42   my $rest = eval { $self->next::method };
  43   return $@ ? $cache : { %$cache, %$rest };
  44 }
  45
  46 1;
  47
  48 =head1 NAME
  49
  50 DBIx::Class - Extensible and flexible object <-> relational mapper.
  51
  52 =head1 GETTING HELP/SUPPORT
  53
  54 The community can be found via:
  55
  56   Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/
  57
  58   SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/
  59
  60   SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/
  61
  62   IRC: irc.perl.org#dbix-class
  63
  64 =head1 SYNOPSIS
  65
  66 Create a schema class called MyDB/Schema.pm:
  67
  68   package MyDB::Schema;
  69   use base qw/DBIx::Class::Schema/;
  70
  71   __PACKAGE__->load_namespaces();
  72
  73   1;
  74
  75 Create a table class to represent artists, who have many CDs, in
  76 MyDB/Schema/Result/Artist.pm:
  77
  78   package MyDB::Schema::Result::Artist;
  79   use base qw/DBIx::Class/;
  80
  81   __PACKAGE__->load_components(qw/Core/);
  82   __PACKAGE__->table('artist');
  83   __PACKAGE__->add_columns(qw/ artistid name /);
  84   __PACKAGE__->set_primary_key('artistid');
  85   __PACKAGE__->has_many(cds => 'MyDB::Schema::Result::CD');
  86
  87   1;
  88
  89 A table class to represent a CD, which belongs to an artist, in
  90 MyDB/Schema/Result/CD.pm:
  91
  92   package MyDB::Schema::Result::CD;
  93   use base qw/DBIx::Class/;
  94
  95   __PACKAGE__->load_components(qw/Core/);
  96   __PACKAGE__->table('cd');
  97   __PACKAGE__->add_columns(qw/ cdid artistid title year /);
  98   __PACKAGE__->set_primary_key('cdid');
  99   __PACKAGE__->belongs_to(artist => 'MyDB::Schema::Artist', 'artistid');
 100
 101   1;
 102
 103 Then you can use these classes in your application's code:
 104
 105   # Connect to your database.
 106   use MyDB::Schema;
 107   my $schema = MyDB::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params);
 108
 109   # Query for all artists and put them in an array,
 110   # or retrieve them as a result set object.
 111   my @all_artists = $schema->resultset('Artist')->all;
 112   my $all_artists_rs = $schema->resultset('Artist');
 113
 114   # Create a result set to search for artists.
 115   # This does not query the DB.
 116   my $johns_rs = $schema->resultset('Artist')->search(
 117     # Build your WHERE using an SQL::Abstract structure:
 118     { name => { like => 'John%' } }
 119   );
 120
 121   # Execute a joined query to get the cds.
 122   my @all_john_cds = $johns_rs->search_related('cds')->all;
 123
 124   # Fetch the next available row.
 125   my $first_john = $johns_rs->next;
 126
 127   # Specify ORDER BY on the query.
 128   my $first_john_cds_by_title_rs = $first_john->cds(
 129     undef,
 130     { order_by => 'title' }
 131   );
 132
 133   # Create a result set that will fetch the artist data
 134   # at the same time as it fetches CDs, using only one query.
 135   my $millennium_cds_rs = $schema->resultset('CD')->search(
 136     { year => 2000 },
 137     { prefetch => 'artist' }
 138   );
 139
 140   my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
 141   my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query
 142
 143   # new() makes a DBIx::Class::Row object but doesnt insert it into the DB.
 144   # create() is the same as new() then insert().
 145   my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
 146   $new_cd->artist($cd->artist);
 147   $new_cd->insert; # Auto-increment primary key filled in after INSERT
 148   $new_cd->title('Fork');
 149
 150   $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
 151
 152   # change the year of all the millennium CDs at once
 153   $millennium_cds_rs->update({ year => 2002 });
 154
 155 =head1 DESCRIPTION
 156
 157 This is an SQL to OO mapper with an object API inspired by L<Class::DBI>
 158 (with a compatibility layer as a springboard for porting) and a resultset API
 159 that allows abstract encapsulation of database operations. It aims to make
 160 representing queries in your code as perl-ish as possible while still
 161 providing access to as many of the capabilities of the database as possible,
 162 including retrieving related records from multiple tables in a single query,
 163 JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and HAVING support.
 164
 165 DBIx::Class can handle multi-column primary and foreign keys, complex
 166 queries and database-level paging, and does its best to only query the
 167 database in order to return something you've directly asked for. If a
 168 resultset is used as an iterator it only fetches rows off the statement
 169 handle as requested in order to minimise memory usage. It has auto-increment
 170 support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is
 171 known to be used in production on at least the first four, and is fork-
 172 and thread-safe out of the box (although your DBD may not be).
 173
 174 This project is still under rapid development, so large new features may be
 175 marked EXPERIMENTAL - such APIs are still usable but may have edge bugs.
 176 Failing test cases are *always* welcome and point releases are put out rapidly
 177 as bugs are found and fixed.
 178
 179 We do our best to maintain full backwards compatibility for published
 180 APIs, since DBIx::Class is used in production in many organisations,
 181 and even backwards incompatible changes to non-published APIs will be fixed
 182 if they're reported and doing so doesn't cost the codebase anything.
 183
 184 The test suite is quite substantial, and several developer releases
 185 are generally made to CPAN before the branch for the next release is
 186 merged back to trunk for a major release.
 187
 188 =head1 WHERE TO GO NEXT
 189
 190 L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
 191 the modules where you will find documentation.
 192
 193 =head1 AUTHOR
 194
 195 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
 196
 197 (I mostly consider myself "project founder" these days but the AUTHOR heading
 198 is traditional :)
 199
 200 =head1 CONTRIBUTORS
 201
 202 abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
 203
 204 aherzog: Adam Herzog <adam@herzogdesigns.com>
 205
 206 andyg: Andy Grundman <andy@hybridized.org>
 207
 208 ank: Andres Kievsky
 209
 210 ash: Ash Berlin <ash@cpan.org>
 211
 212 bert: Norbert Csongradi <bert@cpan.org>
 213
 214 blblack: Brandon L. Black <blblack@gmail.com>
 215
 216 bluefeet: Aran Deltac <bluefeet@cpan.org>
 217
 218 bricas: Brian Cassidy <bricas@cpan.org>
 219
 220 caelum: Rafael Kitover <rkitover@cpan.org>
 221
 222 castaway: Jess Robinson
 223
 224 claco: Christopher H. Laco
 225
 226 clkao: CL Kao
 227
 228 da5id: David Jack Olrik <djo@cpan.org>
 229
 230 debolaz: Anders Nor Berle <berle@cpan.org>
 231
 232 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
 233
 234 dnm: Justin Wheeler <jwheeler@datademons.com>
 235
 236 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
 237
 238 dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
 239
 240 gphat: Cory G Watson <gphat@cpan.org>
 241
 242 groditi: Guillermo Roditi <groditi@cpan.org>
 243
 244 jesper: Jesper Krogh
 245
 246 jgoulah: John Goulah <jgoulah@cpan.org>
 247
 248 jguenther: Justin Guenther <jguenther@cpan.org>
 249
 250 jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
 251
 252 jon: Jon Schutz <jjschutz@cpan.org>
 253
 254 jshirley: J. Shirley <jshirley@gmail.com>
 255
 256 konobi: Scott McWhirter
 257
 258 lukes: Luke Saunders <luke.saunders@gmail.com>
 259
 260 marcus: Marcus Ramberg <mramberg@cpan.org>
 261
 262 mattlaw: Matt Lawrence
 263
 264 michaelr: Michael Reddick <michael.reddick@gmail.com>
 265
 266 ned: Neil de Carteret
 267
 268 nigel: Nigel Metheringham <nigelm@cpan.org>
 269
 270 ningu: David Kamholz <dkamholz@cpan.org>
 271
 272 Numa: Dan Sully <daniel@cpan.org>
 273
 274 oyse: Øystein Torget <oystein.torget@dnv.com>
 275
 276 paulm: Paul Makepeace
 277
 278 penguin: K J Cheetham
 279
 280 perigrin: Chris Prather <chris@prather.org>
 281
 282 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
 283
 284 plu: Johannes Plunien <plu@cpan.org>
 285
 286 quicksilver: Jules Bean
 287
 288 rafl: Florian Ragwitz <rafl@debian.org>
 289
 290 rdj: Ryan D Johnson <ryan@innerfence.com>
 291
 292 ribasushi: Peter Rabbitson <rabbit+dbic@rabbit.us>
 293
 294 rjbs: Ricardo Signes <rjbs@cpan.org>
 295
 296 robkinyon: Rob Kinyon <rkinyon@cpan.org>
 297
 298 sc_: Just Another Perl Hacker
 299
 300 scotty: Scotty Allen <scotty@scottyallen.com>
 301
 302 semifor: Marc Mims <marc@questright.com>
 303
 304 sszabo: Stephan Szabo <sszabo@bigpanda.com>
 305
 306 teejay : Aaron Trevena <teejay@cpan.org>
 307
 308 Todd Lipcon
 309
 310 Tom Hukins
 311
 312 typester: Daisuke Murase <typester@cpan.org>
 313
 314 victori: Victor Igumnov <victori@cpan.org>
 315
 316 wdh: Will Hawes
 317
 318 willert: Sebastian Willert <willert@cpan.org>
 319
 320 wreis: Wallace Reis <wreis@cpan.org>
 321
 322 zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
 323
 324 norbi: Norbert Buchmuller <norbi@nix.hu>
 325
 326 solomon: Jared Johnson <jaredj@nmgi.com>
 327
 328 =head1 LICENSE
 329
 330 You may distribute this code under the same terms as Perl itself.
 331
 332 =cut