lib/DBIx/Class.pm

   1 package DBIx::Class;
   2
   3 use strict;
   4 use warnings;
   5
   6 use MRO::Compat;
   7 use mro 'c3';
   8
   9 use DBIx::Class::Optional::Dependencies;
  10
  11 use vars qw($VERSION);
  12 use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/;
  13 use DBIx::Class::StartupCheck;
  14
  15 sub mk_classdata {
  16   shift->mk_classaccessor(@_);
  17 }
  18
  19 sub mk_classaccessor {
  20   my $self = shift;
  21   $self->mk_group_accessors('inherited', $_[0]);
  22   $self->set_inherited(@_) if @_ > 1;
  23 }
  24
  25 sub component_base_class { 'DBIx::Class' }
  26
  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.08126';
  31
  32 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
  33
  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];
  39   return ();
  40 }
  41
  42 sub _attr_cache {
  43   my $self = shift;
  44   my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {};
  45
  46   return {
  47     %$cache,
  48     %{ $self->maybe::next::method || {} },
  49   };
  50 }
  51
  52 1;
  53
  54 =head1 NAME
  55
  56 DBIx::Class - Extensible and flexible object <-> relational mapper.
  57
  58 =head1 GETTING HELP/SUPPORT
  59
  60 The community can be found via:
  61
  62 =over
  63
  64 =item * Web Site: L<http://www.dbix-class.org/>
  65
  66 =item * IRC: irc.perl.org#dbix-class
  67
  68 =for html
  69 <a href="http://chat.mibbit.com/#dbix-class@irc.perl.org">(click for instant chatroom login)</a>
  70
  71 =item * Mailing list: L<http://lists.scsys.co.uk/mailman/listinfo/dbix-class>
  72
  73 =item * RT Bug Tracker: L<https://rt.cpan.org/Dist/Display.html?Queue=DBIx-Class>
  74
  75 =item * gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git>
  76
  77 =item * git: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git>
  78
  79 =item * twitter L<http://www.twitter.com/dbix_class>
  80
  81 =back
  82
  83 =head1 SYNOPSIS
  84
  85 Create a schema class called MyDB/Schema.pm:
  86
  87   package MyDB::Schema;
  88   use base qw/DBIx::Class::Schema/;
  89
  90   __PACKAGE__->load_namespaces();
  91
  92   1;
  93
  94 Create a result class to represent artists, who have many CDs, in
  95 MyDB/Schema/Result/Artist.pm:
  96
  97 See L<DBIx::Class::ResultSource> for docs on defining result classes.
  98
  99   package MyDB::Schema::Result::Artist;
 100   use base qw/DBIx::Class::Core/;
 101
 102   __PACKAGE__->table('artist');
 103   __PACKAGE__->add_columns(qw/ artistid name /);
 104   __PACKAGE__->set_primary_key('artistid');
 105   __PACKAGE__->has_many(cds => 'MyDB::Schema::Result::CD');
 106
 107   1;
 108
 109 A result class to represent a CD, which belongs to an artist, in
 110 MyDB/Schema/Result/CD.pm:
 111
 112   package MyDB::Schema::Result::CD;
 113   use base qw/DBIx::Class::Core/;
 114
 115   __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
 116   __PACKAGE__->table('cd');
 117   __PACKAGE__->add_columns(qw/ cdid artistid title year /);
 118   __PACKAGE__->set_primary_key('cdid');
 119   __PACKAGE__->belongs_to(artist => 'MyDB::Schema::Result::Artist', 'artistid');
 120
 121   1;
 122
 123 Then you can use these classes in your application's code:
 124
 125   # Connect to your database.
 126   use MyDB::Schema;
 127   my $schema = MyDB::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params);
 128
 129   # Query for all artists and put them in an array,
 130   # or retrieve them as a result set object.
 131   # $schema->resultset returns a DBIx::Class::ResultSet
 132   my @all_artists = $schema->resultset('Artist')->all;
 133   my $all_artists_rs = $schema->resultset('Artist');
 134
 135   # Output all artists names
 136   # $artist here is a DBIx::Class::Row, which has accessors
 137   # for all its columns. Rows are also subclasses of your Result class.
 138   foreach $artist (@all_artists) {
 139     print $artist->name, "\n";
 140   }
 141
 142   # Create a result set to search for artists.
 143   # This does not query the DB.
 144   my $johns_rs = $schema->resultset('Artist')->search(
 145     # Build your WHERE using an SQL::Abstract structure:
 146     { name => { like => 'John%' } }
 147   );
 148
 149   # Execute a joined query to get the cds.
 150   my @all_john_cds = $johns_rs->search_related('cds')->all;
 151
 152   # Fetch the next available row.
 153   my $first_john = $johns_rs->next;
 154
 155   # Specify ORDER BY on the query.
 156   my $first_john_cds_by_title_rs = $first_john->cds(
 157     undef,
 158     { order_by => 'title' }
 159   );
 160
 161   # Create a result set that will fetch the artist data
 162   # at the same time as it fetches CDs, using only one query.
 163   my $millennium_cds_rs = $schema->resultset('CD')->search(
 164     { year => 2000 },
 165     { prefetch => 'artist' }
 166   );
 167
 168   my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
 169   my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query
 170
 171   # new() makes a DBIx::Class::Row object but doesnt insert it into the DB.
 172   # create() is the same as new() then insert().
 173   my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
 174   $new_cd->artist($cd->artist);
 175   $new_cd->insert; # Auto-increment primary key filled in after INSERT
 176   $new_cd->title('Fork');
 177
 178   $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
 179
 180   # change the year of all the millennium CDs at once
 181   $millennium_cds_rs->update({ year => 2002 });
 182
 183 =head1 DESCRIPTION
 184
 185 This is an SQL to OO mapper with an object API inspired by L<Class::DBI>
 186 (with a compatibility layer as a springboard for porting) and a resultset API
 187 that allows abstract encapsulation of database operations. It aims to make
 188 representing queries in your code as perl-ish as possible while still
 189 providing access to as many of the capabilities of the database as possible,
 190 including retrieving related records from multiple tables in a single query,
 191 JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and HAVING support.
 192
 193 DBIx::Class can handle multi-column primary and foreign keys, complex
 194 queries and database-level paging, and does its best to only query the
 195 database in order to return something you've directly asked for. If a
 196 resultset is used as an iterator it only fetches rows off the statement
 197 handle as requested in order to minimise memory usage. It has auto-increment
 198 support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is
 199 known to be used in production on at least the first four, and is fork-
 200 and thread-safe out of the box (although
 201 L<your DBD may not be|DBI/Threads_and_Thread_Safety>).
 202
 203 This project is still under rapid development, so large new features may be
 204 marked EXPERIMENTAL - such APIs are still usable but may have edge bugs.
 205 Failing test cases are *always* welcome and point releases are put out rapidly
 206 as bugs are found and fixed.
 207
 208 We do our best to maintain full backwards compatibility for published
 209 APIs, since DBIx::Class is used in production in many organisations,
 210 and even backwards incompatible changes to non-published APIs will be fixed
 211 if they're reported and doing so doesn't cost the codebase anything.
 212
 213 The test suite is quite substantial, and several developer releases
 214 are generally made to CPAN before the branch for the next release is
 215 merged back to trunk for a major release.
 216
 217 =head1 WHERE TO GO NEXT
 218
 219 L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
 220 the modules where you will find documentation.
 221
 222 =head1 AUTHOR
 223
 224 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
 225
 226 (I mostly consider myself "project founder" these days but the AUTHOR heading
 227 is traditional :)
 228
 229 =head1 CONTRIBUTORS
 230
 231 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
 232
 233 aherzog: Adam Herzog <adam@herzogdesigns.com>
 234
 235 Alexander Keusch <cpan@keusch.at>
 236
 237 alnewkirk: Al Newkirk <we@ana.im>
 238
 239 amiri: Amiri Barksdale <amiri@metalabel.com>
 240
 241 amoore: Andrew Moore <amoore@cpan.org>
 242
 243 andyg: Andy Grundman <andy@hybridized.org>
 244
 245 ank: Andres Kievsky
 246
 247 arc: Aaron Crane <arc@cpan.org>
 248
 249 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
 250
 251 ash: Ash Berlin <ash@cpan.org>
 252
 253 bert: Norbert Csongradi <bert@cpan.org>
 254
 255 blblack: Brandon L. Black <blblack@gmail.com>
 256
 257 bluefeet: Aran Deltac <bluefeet@cpan.org>
 258
 259 bphillips: Brian Phillips <bphillips@cpan.org>
 260
 261 boghead: Bryan Beeley <cpan@beeley.org>
 262
 263 bricas: Brian Cassidy <bricas@cpan.org>
 264
 265 brunov: Bruno Vecchi <vecchi.b@gmail.com>
 266
 267 caelum: Rafael Kitover <rkitover@cpan.org>
 268
 269 castaway: Jess Robinson
 270
 271 claco: Christopher H. Laco
 272
 273 clkao: CL Kao
 274
 275 da5id: David Jack Olrik <djo@cpan.org>
 276
 277 debolaz: Anders Nor Berle <berle@cpan.org>
 278
 279 dew: Dan Thomas <dan@godders.org>
 280
 281 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
 282
 283 dnm: Justin Wheeler <jwheeler@datademons.com>
 284
 285 dpetrov: Dimitar Petrov <mitakaa@gmail.com>
 286
 287 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
 288
 289 dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
 290
 291 freetime: Bill Moseley <moseley@hank.org>
 292
 293 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
 294
 295 goraxe: Gordon Irving <goraxe@cpan.org>
 296
 297 gphat: Cory G Watson <gphat@cpan.org>
 298
 299 groditi: Guillermo Roditi <groditi@cpan.org>
 300
 301 Haarg: Graham Knop <haarg@haarg.org>
 302
 303 hobbs: Andrew Rodland <arodland@cpan.org>
 304
 305 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
 306
 307 initself: Mike Baas <mike@initselftech.com>
 308
 309 jasonmay: Jason May <jason.a.may@gmail.com>
 310
 311 jesper: Jesper Krogh
 312
 313 jgoulah: John Goulah <jgoulah@cpan.org>
 314
 315 jguenther: Justin Guenther <jguenther@cpan.org>
 316
 317 jhannah: Jay Hannah <jay@jays.net>
 318
 319 jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
 320
 321 jon: Jon Schutz <jjschutz@cpan.org>
 322
 323 jshirley: J. Shirley <jshirley@gmail.com>
 324
 325 kaare: Kaare Rasmussen
 326
 327 konobi: Scott McWhirter
 328
 329 lukes: Luke Saunders <luke.saunders@gmail.com>
 330
 331 marcus: Marcus Ramberg <mramberg@cpan.org>
 332
 333 mattlaw: Matt Lawrence
 334
 335 michaelr: Michael Reddick <michael.reddick@gmail.com>
 336
 337 ned: Neil de Carteret
 338
 339 nigel: Nigel Metheringham <nigelm@cpan.org>
 340
 341 ningu: David Kamholz <dkamholz@cpan.org>
 342
 343 Nniuq: Ron "Quinn" Straight" <quinnfazigu@gmail.org>
 344
 345 norbi: Norbert Buchmuller <norbi@nix.hu>
 346
 347 nuba: Nuba Princigalli <nuba@cpan.org>
 348
 349 Numa: Dan Sully <daniel@cpan.org>
 350
 351 ovid: Curtis "Ovid" Poe <ovid@cpan.org>
 352
 353 oyse: Øystein Torget <oystein.torget@dnv.com>
 354
 355 paulm: Paul Makepeace
 356
 357 penguin: K J Cheetham
 358
 359 perigrin: Chris Prather <chris@prather.org>
 360
 361 peter: Peter Collingbourne <peter@pcc.me.uk>
 362
 363 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
 364
 365 plu: Johannes Plunien <plu@cpan.org>
 366
 367 Possum: Daniel LeWarne <possum@cpan.org>
 368
 369 quicksilver: Jules Bean
 370
 371 rafl: Florian Ragwitz <rafl@debian.org>
 372
 373 rainboxx: Matthias Dietrich <perl@rb.ly>
 374
 375 rbo: Robert Bohne <rbo@cpan.org>
 376
 377 rbuels: Robert Buels <rmb32@cornell.edu>
 378
 379 rdj: Ryan D Johnson <ryan@innerfence.com>
 380
 381 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
 382
 383 rjbs: Ricardo Signes <rjbs@cpan.org>
 384
 385 robkinyon: Rob Kinyon <rkinyon@cpan.org>
 386
 387 Roman: Roman Filippov <romanf@cpan.org>
 388
 389 Sadrak: Felix Antonius Wilhelm Ostmann <sadrak@cpan.org>
 390
 391 sc_: Just Another Perl Hacker
 392
 393 scotty: Scotty Allen <scotty@scottyallen.com>
 394
 395 semifor: Marc Mims <marc@questright.com>
 396
 397 solomon: Jared Johnson <jaredj@nmgi.com>
 398
 399 spb: Stephen Bennett <stephen@freenode.net>
 400
 401 Squeeks <squeek@cpan.org>
 402
 403 sszabo: Stephan Szabo <sszabo@bigpanda.com>
 404
 405 talexb: Alex Beamish <talexb@gmail.com>
 406
 407 teejay : Aaron Trevena <teejay@cpan.org>
 408
 409 Todd Lipcon
 410
 411 Tom Hukins
 412
 413 tonvoon: Ton Voon <tonvoon@cpan.org>
 414
 415 triode: Pete Gamache <gamache@cpan.org>
 416
 417 typester: Daisuke Murase <typester@cpan.org>
 418
 419 victori: Victor Igumnov <victori@cpan.org>
 420
 421 wdh: Will Hawes
 422
 423 willert: Sebastian Willert <willert@cpan.org>
 424
 425 wreis: Wallace Reis <wreis@cpan.org>
 426
 427 yrlnry: Mark Jason Dominus <mjd@plover.com>
 428
 429 zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
 430
 431 =head1 COPYRIGHT
 432
 433 Copyright (c) 2005 - 2010 the DBIx::Class L</AUTHOR> and L</CONTRIBUTORS>
 434 as listed above.
 435
 436 =head1 LICENSE
 437
 438 This library is free software and may be distributed under the same terms
 439 as perl itself.
 440
 441 =cut