X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=b0d9b1c044b8521aa316b3241fc688ebbd49f86c;hb=79346e56a9ebf94b504a2ee19e96ff3547a77321;hp=e34b47ff0632913f9978c034a948e818ec29d46f;hpb=e4c9f3f0bdb9283c12f49dcc29795beb99fffbbe;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index e34b47f..b0d9b1c 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -3,12 +3,29 @@ package DBIx::Class; use strict; use warnings; -use MRO::Compat; +our $VERSION; +# Always remember to do all digits for the version even if they're 0 +# i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports +# brain damage and presumably various other packaging systems too + +# $VERSION declaration must stay up here, ahead of any other package +# declarations, as to not confuse various modules attempting to determine +# this ones version, whether that be s.c.o. or Module::Metadata, etc +$VERSION = '0.082810'; + +$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases + +use DBIx::Class::_Util; use mro 'c3'; -use vars qw($VERSION); -use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/; +use DBIx::Class::Optional::Dependencies; + +use base qw/DBIx::Class::Componentised DBIx::Class::AccessorGroup/; use DBIx::Class::StartupCheck; +use DBIx::Class::Exception; + +__PACKAGE__->mk_group_accessors(inherited => '_skip_namespace_frames'); +__PACKAGE__->_skip_namespace_frames('^DBIx::Class|^SQL::Abstract|^Try::Tiny|^Class::Accessor::Grouped|^Context::Preserve'); sub mk_classdata { shift->mk_classaccessor(@_); @@ -22,13 +39,6 @@ sub mk_classaccessor { sub component_base_class { 'DBIx::Class' } -# Always remember to do all digits for the version even if they're 0 -# i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports -# brain damage and presumably various other packaging systems too -$VERSION = '0.08115'; - -$VERSION = eval $VERSION; # numify for warning-free dev releases - sub MODIFY_CODE_ATTRIBUTES { my ($class,$code,@attrs) = @_; $class->mk_classdata('__attr_cache' => {}) @@ -40,33 +50,73 @@ sub MODIFY_CODE_ATTRIBUTES { sub _attr_cache { my $self = shift; my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {}; - my $rest = eval { $self->next::method }; - return $@ ? $cache : { %$cache, %$rest }; + + return { + %$cache, + %{ $self->maybe::next::method || {} }, + }; +} + +# *DO NOT* change this URL nor the identically named =head1 below +# it is linked throughout the ecosystem +sub DBIx::Class::_ENV_::HELP_URL () { + 'http://p3rl.org/DBIx::Class#GETTING_HELP/SUPPORT' } 1; +__END__ + =head1 NAME DBIx::Class - Extensible and flexible object <-> relational mapper. +=head1 WHERE TO START READING + +See L for an overview of the exhaustive documentation. +To get the most out of DBIx::Class with the least confusion it is strongly +recommended to read (at the very least) the +L in the order presented there. + +=cut + =head1 GETTING HELP/SUPPORT -The community can be found via: +Due to the sheer size of its problem domain, DBIx::Class is a relatively +complex framework. After you start using DBIx::Class questions will inevitably +arise. If you are stuck with a problem or have doubts about a particular +approach do not hesitate to contact us via any of the following options (the +list is sorted by "fastest response time"): + +=over + +=item * IRC: irc.perl.org#dbix-class - Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/ +=for html +(click for instant chatroom login) - SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/ +=item * Mailing list: L - SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/ +=item * RT Bug Tracker: L - IRC: irc.perl.org#dbix-class +=item * Twitter: L + +=item * Web Site: L + +=back =head1 SYNOPSIS -Create a schema class called MyDB/Schema.pm: +For the very impatient: L + +This code in the next step can be generated automatically from an existing +database, see L from the distribution C. - package MyDB::Schema; +=head2 Schema classes preparation + +Create a schema class called F: + + package MyApp::Schema; use base qw/DBIx::Class::Schema/; __PACKAGE__->load_namespaces(); @@ -74,39 +124,41 @@ Create a schema class called MyDB/Schema.pm: 1; Create a result class to represent artists, who have many CDs, in -MyDB/Schema/Result/Artist.pm: +F: See L for docs on defining result classes. - package MyDB::Schema::Result::Artist; + package MyApp::Schema::Result::Artist; use base qw/DBIx::Class::Core/; __PACKAGE__->table('artist'); __PACKAGE__->add_columns(qw/ artistid name /); __PACKAGE__->set_primary_key('artistid'); - __PACKAGE__->has_many(cds => 'MyDB::Schema::Result::CD'); + __PACKAGE__->has_many(cds => 'MyApp::Schema::Result::CD', 'artistid'); 1; A result class to represent a CD, which belongs to an artist, in -MyDB/Schema/Result/CD.pm: +F: - package MyDB::Schema::Result::CD; + package MyApp::Schema::Result::CD; use base qw/DBIx::Class::Core/; __PACKAGE__->load_components(qw/InflateColumn::DateTime/); __PACKAGE__->table('cd'); __PACKAGE__->add_columns(qw/ cdid artistid title year /); __PACKAGE__->set_primary_key('cdid'); - __PACKAGE__->belongs_to(artist => 'MyDB::Schema::Artist', 'artistid'); + __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Result::Artist', 'artistid'); 1; +=head2 API usage + Then you can use these classes in your application's code: # Connect to your database. - use MyDB::Schema; - my $schema = MyDB::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params); + use MyApp::Schema; + my $schema = MyApp::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params); # Query for all artists and put them in an array, # or retrieve them as a result set object. @@ -150,7 +202,7 @@ Then you can use these classes in your application's code: my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ... my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query - # new() makes a DBIx::Class::Row object but doesnt insert it into the DB. + # new() makes a Result object but doesnt insert it into the DB. # create() is the same as new() then insert(). my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' }); $new_cd->artist($cd->artist); @@ -170,7 +222,8 @@ that allows abstract encapsulation of database operations. It aims to make representing queries in your code as perl-ish as possible while still providing access to as many of the capabilities of the database as possible, including retrieving related records from multiple tables in a single query, -JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and HAVING support. +C, C, C, C, C, C and +C support. DBIx::Class can handle multi-column primary and foreign keys, complex queries and database-level paging, and does its best to only query the @@ -179,11 +232,12 @@ resultset is used as an iterator it only fetches rows off the statement handle as requested in order to minimise memory usage. It has auto-increment support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is known to be used in production on at least the first four, and is fork- -and thread-safe out of the box (although your DBD may not be). +and thread-safe out of the box (although +L). This project is still under rapid development, so large new features may be -marked EXPERIMENTAL - such APIs are still usable but may have edge bugs. -Failing test cases are *always* welcome and point releases are put out rapidly +marked B - such APIs are still usable but may have edge bugs. +Failing test cases are I welcome and point releases are put out rapidly as bugs are found and fixed. We do our best to maintain full backwards compatibility for published @@ -195,178 +249,78 @@ The test suite is quite substantial, and several developer releases are generally made to CPAN before the branch for the next release is merged back to trunk for a major release. -=head1 WHERE TO GO NEXT - -L lists each task you might want help on, and -the modules where you will find documentation. - -=head1 AUTHOR - -mst: Matt S. Trout - -(I mostly consider myself "project founder" these days but the AUTHOR heading -is traditional :) - -=head1 CONTRIBUTORS - -abraxxa: Alexander Hartmaier - -aherzog: Adam Herzog - -andyg: Andy Grundman - -ank: Andres Kievsky - -arcanez: Justin Hunter - -ash: Ash Berlin - -bert: Norbert Csongradi - -blblack: Brandon L. Black - -bluefeet: Aran Deltac - -bricas: Brian Cassidy - -brunov: Bruno Vecchi +=head1 HOW TO CONTRIBUTE -caelum: Rafael Kitover +Contributions are always welcome, in all usable forms (we especially +welcome documentation improvements). The delivery methods include git- +or unified-diff formatted patches, GitHub pull requests, or plain bug +reports either via RT or the Mailing list. Contributors are generally +granted access to the official repository after their first several +patches pass successful review. Don't hesitate to +L either of the L with +any further questions you may have. -castaway: Jess Robinson +=for comment +FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;) -claco: Christopher H. Laco +This project is maintained in a git repository. The code and related tools are +accessible at the following locations: -clkao: CL Kao +=over -da5id: David Jack Olrik +=item * Official repo: L -debolaz: Anders Nor Berle +=item * Official gitweb: L -dkubb: Dan Kubb +=item * GitHub mirror: L -dnm: Justin Wheeler +=item * Authorized committers: L -dwc: Daniel Westermann-Clark +=item * Travis-CI log: L -dyfrgi: Michael Leuchtenburg +=for html +↪ Stable branch CI status: -frew: Arthur Axel "fREW" Schmidt +=back -gphat: Cory G Watson +=head1 AUTHORS -groditi: Guillermo Roditi +Even though a large portion of the source I to be written by just a +handful of people, this library continues to remain a collaborative effort - +perhaps one of the most successful such projects on L. +It is important to remember that ideas do not always result in a direct code +contribution, but deserve acknowledgement just the same. Time and time again +the seemingly most insignificant questions and suggestions have been shown +to catalyze monumental improvements in consistency, accuracy and performance. -ilmari: Dagfinn Ilmari MannsEker +=for comment this line is replaced with the author list at dist-building time -jasonmay: Jason May +The canonical source of authors and their details is the F file at +the root of this distribution (or repository). The canonical source of +per-line authorship is the L history +itself. -jesper: Jesper Krogh +=head1 CAT HERDERS -jgoulah: John Goulah +The fine folks nudging the project in a particular direction: -jguenther: Justin Guenther +=over -jnapiorkowski: John Napiorkowski +B: Peter Rabbitson +(present day maintenance and controlled evolution) -jon: Jon Schutz +B: Jess Robinson +(lions share of the reference documentation and manuals) -jshirley: J. Shirley +B: Matt S Trout (project founder - +original idea, architecture and implementation) -konobi: Scott McWhirter +=back -lukes: Luke Saunders +=head1 COPYRIGHT AND LICENSE -marcus: Marcus Ramberg - -mattlaw: Matt Lawrence - -michaelr: Michael Reddick - -ned: Neil de Carteret - -nigel: Nigel Metheringham - -ningu: David Kamholz - -Nniuq: Ron "Quinn" Straight" - -norbi: Norbert Buchmuller - -Numa: Dan Sully - -ovid: Curtis "Ovid" Poe - -oyse: Øystein Torget - -paulm: Paul Makepeace - -penguin: K J Cheetham - -perigrin: Chris Prather - -peter: Peter Collingbourne - -phaylon: Robert Sedlacek - -plu: Johannes Plunien - -quicksilver: Jules Bean - -rafl: Florian Ragwitz - -rbuels: Robert Buels - -rdj: Ryan D Johnson - -ribasushi: Peter Rabbitson - -rjbs: Ricardo Signes - -robkinyon: Rob Kinyon - -Roman: Roman Filippov - -sc_: Just Another Perl Hacker - -scotty: Scotty Allen - -semifor: Marc Mims - -solomon: Jared Johnson - -spb: Stephen Bennett - -sszabo: Stephan Szabo - -teejay : Aaron Trevena - -Todd Lipcon - -Tom Hukins - -triode: Pete Gamache - -typester: Daisuke Murase - -victori: Victor Igumnov - -wdh: Will Hawes - -willert: Sebastian Willert - -wreis: Wallace Reis - -zamolxes: Bogdan Lucaciu - -=head1 COPYRIGHT - -Copyright (c) 2005 - 2009 the DBIx::Class L and L -as listed above. - -=head1 LICENSE +Copyright (c) 2005 by mst, castaway, ribasushi, and other DBIx::Class +L as listed above and in F. This library is free software and may be distributed under the same terms -as perl itself. - -=cut +as perl5 itself. See F for the complete licensing terms.