lib/DBIx/Class.pm

   1 package DBIx::Class;
   2
   3 use strict;
   4 use warnings;
   5
   6 our $VERSION;
   7 # Always remember to do all digits for the version even if they're 0
   8 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
   9 # brain damage and presumably various other packaging systems too
  10
  11 # $VERSION declaration must stay up here, ahead of any other package
  12 # declarations, as to not confuse various modules attempting to determine
  13 # this ones version, whether that be s.c.o. or Module::Metadata, etc
  14 $VERSION = '0.08271';
  15
  16 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
  17
  18 use DBIx::Class::_Util;
  19 use mro 'c3';
  20
  21 use DBIx::Class::Optional::Dependencies;
  22
  23 use base qw/DBIx::Class::Componentised DBIx::Class::AccessorGroup/;
  24 use DBIx::Class::StartupCheck;
  25 use DBIx::Class::Exception;
  26
  27 __PACKAGE__->mk_group_accessors(inherited => '_skip_namespace_frames');
  28 __PACKAGE__->_skip_namespace_frames('^DBIx::Class|^SQL::Abstract|^Try::Tiny|^Class::Accessor::Grouped|^Context::Preserve');
  29
  30 sub mk_classdata {
  31   shift->mk_classaccessor(@_);
  32 }
  33
  34 sub mk_classaccessor {
  35   my $self = shift;
  36   $self->mk_group_accessors('inherited', $_[0]);
  37   $self->set_inherited(@_) if @_ > 1;
  38 }
  39
  40 sub component_base_class { 'DBIx::Class' }
  41
  42 sub MODIFY_CODE_ATTRIBUTES {
  43   my ($class,$code,@attrs) = @_;
  44   $class->mk_classdata('__attr_cache' => {})
  45     unless $class->can('__attr_cache');
  46   $class->__attr_cache->{$code} = [@attrs];
  47   return ();
  48 }
  49
  50 sub _attr_cache {
  51   my $self = shift;
  52   my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {};
  53
  54   return {
  55     %$cache,
  56     %{ $self->maybe::next::method || {} },
  57   };
  58 }
  59
  60 1;
  61
  62 __END__
  63
  64 =encoding UTF-8
  65
  66 =head1 NAME
  67
  68 DBIx::Class - Extensible and flexible object <-> relational mapper.
  69
  70 =head1 WHERE TO START READING
  71
  72 See L<DBIx::Class::Manual::DocMap> for an overview of the exhaustive documentation.
  73 To get the most out of DBIx::Class with the least confusion it is strongly
  74 recommended to read (at the very least) the
  75 L<Manuals|DBIx::Class::Manual::DocMap/Manuals> in the order presented there.
  76
  77 =head1 HOW TO GET HELP
  78
  79 Due to the complexity of its problem domain, DBIx::Class is a relatively
  80 complex framework. After you start using DBIx::Class questions will inevitably
  81 arise. If you are stuck with a problem or have doubts about a particular
  82 approach do not hesitate to contact the community with your questions. The
  83 list below is sorted by "fastest response time":
  84
  85 =over
  86
  87 =item * IRC: irc.perl.org#dbix-class
  88
  89 =for html
  90 <a href="https://chat.mibbit.com/#dbix-class@irc.perl.org">(click for instant chatroom login)</a>
  91
  92 =item * Mailing list: L<http://lists.scsys.co.uk/mailman/listinfo/dbix-class>
  93
  94 =item * RT Bug Tracker: L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=DBIx-Class>
  95
  96 =item * Twitter: L<https://www.twitter.com/dbix_class>
  97
  98 =item * Web Site: L<http://www.dbix-class.org/>
  99
 100 =back
 101
 102 =head1 SYNOPSIS
 103
 104 For the very impatient: L<DBIx::Class::Manual::QuickStart>
 105
 106 This code in the next step can be generated automatically from an existing
 107 database, see L<dbicdump> from the distribution C<DBIx-Class-Schema-Loader>.
 108
 109 =head2 Schema classes preparation
 110
 111 Create a schema class called F<MyApp/Schema.pm>:
 112
 113   package MyApp::Schema;
 114   use base qw/DBIx::Class::Schema/;
 115
 116   __PACKAGE__->load_namespaces();
 117
 118   1;
 119
 120 Create a result class to represent artists, who have many CDs, in
 121 F<MyApp/Schema/Result/Artist.pm>:
 122
 123 See L<DBIx::Class::ResultSource> for docs on defining result classes.
 124
 125   package MyApp::Schema::Result::Artist;
 126   use base qw/DBIx::Class::Core/;
 127
 128   __PACKAGE__->table('artist');
 129   __PACKAGE__->add_columns(qw/ artistid name /);
 130   __PACKAGE__->set_primary_key('artistid');
 131   __PACKAGE__->has_many(cds => 'MyApp::Schema::Result::CD', 'artistid');
 132
 133   1;
 134
 135 A result class to represent a CD, which belongs to an artist, in
 136 F<MyApp/Schema/Result/CD.pm>:
 137
 138   package MyApp::Schema::Result::CD;
 139   use base qw/DBIx::Class::Core/;
 140
 141   __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
 142   __PACKAGE__->table('cd');
 143   __PACKAGE__->add_columns(qw/ cdid artistid title year /);
 144   __PACKAGE__->set_primary_key('cdid');
 145   __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Result::Artist', 'artistid');
 146
 147   1;
 148
 149 =head2 API usage
 150
 151 Then you can use these classes in your application's code:
 152
 153   # Connect to your database.
 154   use MyApp::Schema;
 155   my $schema = MyApp::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params);
 156
 157   # Query for all artists and put them in an array,
 158   # or retrieve them as a result set object.
 159   # $schema->resultset returns a DBIx::Class::ResultSet
 160   my @all_artists = $schema->resultset('Artist')->all;
 161   my $all_artists_rs = $schema->resultset('Artist');
 162
 163   # Output all artists names
 164   # $artist here is a DBIx::Class::Row, which has accessors
 165   # for all its columns. Rows are also subclasses of your Result class.
 166   foreach $artist (@all_artists) {
 167     print $artist->name, "\n";
 168   }
 169
 170   # Create a result set to search for artists.
 171   # This does not query the DB.
 172   my $johns_rs = $schema->resultset('Artist')->search(
 173     # Build your WHERE using an SQL::Abstract structure:
 174     { name => { like => 'John%' } }
 175   );
 176
 177   # Execute a joined query to get the cds.
 178   my @all_john_cds = $johns_rs->search_related('cds')->all;
 179
 180   # Fetch the next available row.
 181   my $first_john = $johns_rs->next;
 182
 183   # Specify ORDER BY on the query.
 184   my $first_john_cds_by_title_rs = $first_john->cds(
 185     undef,
 186     { order_by => 'title' }
 187   );
 188
 189   # Create a result set that will fetch the artist data
 190   # at the same time as it fetches CDs, using only one query.
 191   my $millennium_cds_rs = $schema->resultset('CD')->search(
 192     { year => 2000 },
 193     { prefetch => 'artist' }
 194   );
 195
 196   my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
 197   my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query
 198
 199   # new() makes a Result object but doesnt insert it into the DB.
 200   # create() is the same as new() then insert().
 201   my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
 202   $new_cd->artist($cd->artist);
 203   $new_cd->insert; # Auto-increment primary key filled in after INSERT
 204   $new_cd->title('Fork');
 205
 206   $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
 207
 208   # change the year of all the millennium CDs at once
 209   $millennium_cds_rs->update({ year => 2002 });
 210
 211 =head1 DESCRIPTION
 212
 213 This is an SQL to OO mapper with an object API inspired by L<Class::DBI>
 214 (with a compatibility layer as a springboard for porting) and a resultset API
 215 that allows abstract encapsulation of database operations. It aims to make
 216 representing queries in your code as perl-ish as possible while still
 217 providing access to as many of the capabilities of the database as possible,
 218 including retrieving related records from multiple tables in a single query,
 219 C<JOIN>, C<LEFT JOIN>, C<COUNT>, C<DISTINCT>, C<GROUP BY>, C<ORDER BY> and
 220 C<HAVING> support.
 221
 222 DBIx::Class can handle multi-column primary and foreign keys, complex
 223 queries and database-level paging, and does its best to only query the
 224 database in order to return something you've directly asked for. If a
 225 resultset is used as an iterator it only fetches rows off the statement
 226 handle as requested in order to minimise memory usage. It has auto-increment
 227 support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is
 228 known to be used in production on at least the first four, and is fork-
 229 and thread-safe out of the box (although
 230 L<your DBD may not be|DBI/Threads and Thread Safety>).
 231
 232 This project is still under rapid development, so large new features may be
 233 marked B<experimental> - such APIs are still usable but may have edge bugs.
 234 Failing test cases are I<always> welcome and point releases are put out rapidly
 235 as bugs are found and fixed.
 236
 237 We do our best to maintain full backwards compatibility for published
 238 APIs, since DBIx::Class is used in production in many organisations,
 239 and even backwards incompatible changes to non-published APIs will be fixed
 240 if they're reported and doing so doesn't cost the codebase anything.
 241
 242 The test suite is quite substantial, and several developer releases
 243 are generally made to CPAN before the branch for the next release is
 244 merged back to trunk for a major release.
 245
 246 =head1 HOW TO CONTRIBUTE
 247
 248 Contributions are always welcome, in all usable forms (we especially
 249 welcome documentation improvements). The delivery methods include git-
 250 or unified-diff formatted patches, GitHub pull requests, or plain bug
 251 reports either via RT or the Mailing list. Contributors are generally
 252 granted full access to the official repository after their first patch
 253 passes successful review.
 254
 255 =for comment
 256 FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;)
 257
 258 This project is maintained in a git repository. The code and related tools are
 259 accessible at the following locations:
 260
 261 =over
 262
 263 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git>
 264
 265 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git>
 266
 267 =item * GitHub mirror: L<https://github.com/dbsrgits/DBIx-Class>
 268
 269 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/DBIx-Class.git>
 270
 271 =item * Travis-CI log: L<https://travis-ci.org/dbsrgits/dbix-class/builds>
 272
 273 =back
 274
 275 =head1 AUTHOR
 276
 277 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
 278
 279 (I mostly consider myself "project founder" these days but the AUTHOR heading
 280 is traditional :)
 281
 282 =head1 CONTRIBUTORS
 283
 284 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
 285
 286 acca: Alexander Kuznetsov <acca@cpan.org>
 287
 288 aherzog: Adam Herzog <adam@herzogdesigns.com>
 289
 290 Alexander Keusch <cpan@keusch.at>
 291
 292 alexrj: Alessandro Ranellucci <aar@cpan.org>
 293
 294 alnewkirk: Al Newkirk <we@ana.im>
 295
 296 amiri: Amiri Barksdale <amiri@metalabel.com>
 297
 298 amoore: Andrew Moore <amoore@cpan.org>
 299
 300 andrewalker: Andre Walker <andre@andrewalker.net>
 301
 302 andyg: Andy Grundman <andy@hybridized.org>
 303
 304 ank: Andres Kievsky
 305
 306 arc: Aaron Crane <arc@cpan.org>
 307
 308 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
 309
 310 ash: Ash Berlin <ash@cpan.org>
 311
 312 bert: Norbert Csongrádi <bert@cpan.org>
 313
 314 blblack: Brandon L. Black <blblack@gmail.com>
 315
 316 bluefeet: Aran Deltac <bluefeet@cpan.org>
 317
 318 bphillips: Brian Phillips <bphillips@cpan.org>
 319
 320 boghead: Bryan Beeley <cpan@beeley.org>
 321
 322 brd: Brad Davis <brd@FreeBSD.org>
 323
 324 bricas: Brian Cassidy <bricas@cpan.org>
 325
 326 brunov: Bruno Vecchi <vecchi.b@gmail.com>
 327
 328 caelum: Rafael Kitover <rkitover@cpan.org>
 329
 330 caldrin: Maik Hentsche <maik.hentsche@amd.com>
 331
 332 castaway: Jess Robinson
 333
 334 claco: Christopher H. Laco
 335
 336 clkao: CL Kao
 337
 338 da5id: David Jack Olrik <djo@cpan.org>
 339
 340 dariusj: Darius Jokilehto <dariusjokilehto@yahoo.co.uk>
 341
 342 davewood: David Schmidt <davewood@gmx.at>
 343
 344 daxim: Lars Dɪᴇᴄᴋᴏᴡ 迪拉斯 <daxim@cpan.org>
 345
 346 debolaz: Anders Nor Berle <berle@cpan.org>
 347
 348 dew: Dan Thomas <dan@godders.org>
 349
 350 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
 351
 352 dnm: Justin Wheeler <jwheeler@datademons.com>
 353
 354 dpetrov: Dimitar Petrov <mitakaa@gmail.com>
 355
 356 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
 357
 358 dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
 359
 360 edenc: Eden Cardim <edencardim@gmail.com>
 361
 362 ether: Karen Etheridge <ether@cpan.org>
 363
 364 felliott: Fitz Elliott <fitz.elliott@gmail.com>
 365
 366 freetime: Bill Moseley <moseley@hank.org>
 367
 368 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
 369
 370 goraxe: Gordon Irving <goraxe@cpan.org>
 371
 372 gphat: Cory G Watson <gphat@cpan.org>
 373
 374 Grant Street Group L<http://www.grantstreet.com/>
 375
 376 groditi: Guillermo Roditi <groditi@cpan.org>
 377
 378 Haarg: Graham Knop <haarg@haarg.org>
 379
 380 hobbs: Andrew Rodland <arodland@cpan.org>
 381
 382 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
 383
 384 initself: Mike Baas <mike@initselftech.com>
 385
 386 ironcamel: Naveed Massjouni <naveedm9@gmail.com>
 387
 388 jawnsy: Jonathan Yu <jawnsy@cpan.org>
 389
 390 jasonmay: Jason May <jason.a.may@gmail.com>
 391
 392 jesper: Jesper Krogh
 393
 394 jgoulah: John Goulah <jgoulah@cpan.org>
 395
 396 jguenther: Justin Guenther <jguenther@cpan.org>
 397
 398 jhannah: Jay Hannah <jay@jays.net>
 399
 400 jmac: Jason McIntosh <jmac@appleseed-sc.com>
 401
 402 jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
 403
 404 jon: Jon Schutz <jjschutz@cpan.org>
 405
 406 jshirley: J. Shirley <jshirley@gmail.com>
 407
 408 kaare: Kaare Rasmussen
 409
 410 konobi: Scott McWhirter
 411
 412 littlesavage: Alexey Illarionov <littlesavage@orionet.ru>
 413
 414 lukes: Luke Saunders <luke.saunders@gmail.com>
 415
 416 marcus: Marcus Ramberg <mramberg@cpan.org>
 417
 418 mattlaw: Matt Lawrence
 419
 420 mattp: Matt Phillips <mattp@cpan.org>
 421
 422 michaelr: Michael Reddick <michael.reddick@gmail.com>
 423
 424 milki: Jonathan Chu <milki@rescomp.berkeley.edu>
 425
 426 mithaldu: Christian Walde <walde.christian@gmail.com>
 427
 428 mjemmeson: Michael Jemmeson <michael.jemmeson@gmail.com>
 429
 430 mstratman: Mark A. Stratman <stratman@gmail.com>
 431
 432 ned: Neil de Carteret
 433
 434 nigel: Nigel Metheringham <nigelm@cpan.org>
 435
 436 ningu: David Kamholz <dkamholz@cpan.org>
 437
 438 Nniuq: Ron "Quinn" Straight" <quinnfazigu@gmail.org>
 439
 440 norbi: Norbert Buchmuller <norbi@nix.hu>
 441
 442 nuba: Nuba Princigalli <nuba@cpan.org>
 443
 444 Numa: Dan Sully <daniel@cpan.org>
 445
 446 ovid: Curtis "Ovid" Poe <ovid@cpan.org>
 447
 448 oyse: E<Oslash>ystein Torget <oystein.torget@dnv.com>
 449
 450 paulm: Paul Makepeace
 451
 452 penguin: K J Cheetham
 453
 454 perigrin: Chris Prather <chris@prather.org>
 455
 456 peter: Peter Collingbourne <peter@pcc.me.uk>
 457
 458 Peter Siklósi <einon@einon.hu>
 459
 460 Peter Valdemar ME<oslash>rch <peter@morch.com>
 461
 462 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
 463
 464 plu: Johannes Plunien <plu@cpan.org>
 465
 466 Possum: Daniel LeWarne <possum@cpan.org>
 467
 468 quicksilver: Jules Bean
 469
 470 rafl: Florian Ragwitz <rafl@debian.org>
 471
 472 rainboxx: Matthias Dietrich <perl@rb.ly>
 473
 474 rbo: Robert Bohne <rbo@cpan.org>
 475
 476 rbuels: Robert Buels <rmb32@cornell.edu>
 477
 478 rdj: Ryan D Johnson <ryan@innerfence.com>
 479
 480 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
 481
 482 rjbs: Ricardo Signes <rjbs@cpan.org>
 483
 484 robkinyon: Rob Kinyon <rkinyon@cpan.org>
 485
 486 Robert Olson <bob@rdolson.org>
 487
 488 moltar: Roman Filippov <romanf@cpan.org>
 489
 490 Sadrak: Felix Antonius Wilhelm Ostmann <sadrak@cpan.org>
 491
 492 sc_: Just Another Perl Hacker
 493
 494 scotty: Scotty Allen <scotty@scottyallen.com>
 495
 496 semifor: Marc Mims <marc@questright.com>
 497
 498 SineSwiper: Brendan Byrd <bbyrd@cpan.org>
 499
 500 solomon: Jared Johnson <jaredj@nmgi.com>
 501
 502 spb: Stephen Bennett <stephen@freenode.net>
 503
 504 Squeeks <squeek@cpan.org>
 505
 506 sszabo: Stephan Szabo <sszabo@bigpanda.com>
 507
 508 talexb: Alex Beamish <talexb@gmail.com>
 509
 510 tamias: Ronald J Kimball <rjk@tamias.net>
 511
 512 teejay : Aaron Trevena <teejay@cpan.org>
 513
 514 Todd Lipcon
 515
 516 Tom Hukins
 517
 518 tonvoon: Ton Voon <tonvoon@cpan.org>
 519
 520 triode: Pete Gamache <gamache@cpan.org>
 521
 522 typester: Daisuke Murase <typester@cpan.org>
 523
 524 victori: Victor Igumnov <victori@cpan.org>
 525
 526 wdh: Will Hawes
 527
 528 wesm: Wes Malone <wes@mitsi.com>
 529
 530 willert: Sebastian Willert <willert@cpan.org>
 531
 532 wreis: Wallace Reis <wreis@cpan.org>
 533
 534 xenoterracide: Caleb Cushing <xenoterracide@gmail.com>
 535
 536 yrlnry: Mark Jason Dominus <mjd@plover.com>
 537
 538 zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
 539
 540 Zefram: Andrew Main <zefram@fysh.org>
 541
 542 =head1 COPYRIGHT
 543
 544 Copyright (c) 2005 - 2011 the DBIx::Class L</AUTHOR> and L</CONTRIBUTORS>
 545 as listed above.
 546
 547 =head1 LICENSE
 548
 549 This library is free software and may be distributed under the same terms
 550 as perl itself.