X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=8a8538e510f102582c9ebed7cce033dfffb85221;hb=00d605256e12a025c93f42ff19c2ab3351869e09;hp=a633aa72acfd0f558282692bb0b77e86b2acb58d;hpb=2bb4c37b6a5f36d851c4a8ee6f5791e179491fd0;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index a633aa7..8a8538e 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -3,56 +3,29 @@ package DBIx::Class; use strict; use warnings; -BEGIN { - package DBIx::Class::_ENV_; - - if ($] < 5.009_005) { - require MRO::Compat; - *OLD_MRO = sub () { 1 }; - } - else { - require mro; - *OLD_MRO = sub () { 0 }; - } - - # ::Runmode would only be loaded by DBICTest, which in turn implies t/ - *DBICTEST = eval { DBICTest::RunMode->is_author } - ? sub () { 1 } - : sub () { 0 } - ; - - # During 5.13 dev cycle HELEMs started to leak on copy - *PEEPEENESS = (defined $ENV{DBICTEST_ALL_LEAKS} - # request for all tests would force "non-leaky" illusion and vice-versa - ? ! $ENV{DBICTEST_ALL_LEAKS} - - # otherwise confess that this perl is busted ONLY on smokers - : do { - if (eval { DBICTest::RunMode->is_smoker }) { - - # leaky 5.13.6 (fixed in blead/cefd5c7c) - if ($] == '5.013006') { 1 } +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 - # not sure why this one leaks, but disable anyway - ANDK seems to make it weep - elsif ($] == '5.013005') { 1 } +# $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.082801'; - else { 0 } - } - else { 0 } - } - ) ? sub () { 1 } : sub () { 0 }; -} +$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases +use DBIx::Class::_Util; use mro 'c3'; use DBIx::Class::Optional::Dependencies; -use vars qw($VERSION); 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'); +__PACKAGE__->_skip_namespace_frames('^DBIx::Class|^SQL::Abstract|^Try::Tiny|^Class::Accessor::Grouped|^Context::Preserve'); sub mk_classdata { shift->mk_classaccessor(@_); @@ -66,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.08190_01'; - -$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases - sub MODIFY_CODE_ATTRIBUTES { my ($class,$code,@attrs) = @_; $class->mk_classdata('__attr_cache' => {}) @@ -91,40 +57,64 @@ sub _attr_cache { }; } +# *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 * Web Site: L - =item * IRC: irc.perl.org#dbix-class =for html -(click for instant chatroom login) +(click for instant chatroom login) =item * Mailing list: L -=item * RT Bug Tracker: L - -=item * gitweb: L +=item * RT Bug Tracker: L -=item * git: L +=item * Twitter: L -=item * twitter L +=item * Web Site: L =back =head1 SYNOPSIS -Create a schema class called MyApp/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. + +=head2 Schema classes preparation + +Create a schema class called F: package MyApp::Schema; use base qw/DBIx::Class::Schema/; @@ -134,7 +124,7 @@ Create a schema class called MyApp/Schema.pm: 1; Create a result class to represent artists, who have many CDs, in -MyApp/Schema/Result/Artist.pm: +F: See L for docs on defining result classes. @@ -144,12 +134,12 @@ See L for docs on defining result classes. __PACKAGE__->table('artist'); __PACKAGE__->add_columns(qw/ artistid name /); __PACKAGE__->set_primary_key('artistid'); - __PACKAGE__->has_many(cds => 'MyApp::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 -MyApp/Schema/Result/CD.pm: +F: package MyApp::Schema::Result::CD; use base qw/DBIx::Class::Core/; @@ -162,6 +152,8 @@ MyApp/Schema/Result/CD.pm: 1; +=head2 API usage + Then you can use these classes in your application's code: # Connect to your database. @@ -210,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); @@ -230,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 @@ -240,11 +233,11 @@ 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 -L). +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 @@ -256,250 +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 - -acca: Alexander Kuznetsov - -aherzog: Adam Herzog - -Alexander Keusch - -alnewkirk: Al Newkirk - -amiri: Amiri Barksdale - -amoore: Andrew Moore - -andyg: Andy Grundman - -ank: Andres Kievsky - -arc: Aaron Crane - -arcanez: Justin Hunter - -ash: Ash Berlin - -bert: Norbert Csongradi - -blblack: Brandon L. Black - -bluefeet: Aran Deltac - -bphillips: Brian Phillips - -boghead: Bryan Beeley - -bricas: Brian Cassidy - -brunov: Bruno Vecchi - -caelum: Rafael Kitover - -caldrin: Maik Hentsche - -castaway: Jess Robinson - -claco: Christopher H. Laco - -clkao: CL Kao - -da5id: David Jack Olrik - -debolaz: Anders Nor Berle - -dew: Dan Thomas - -dkubb: Dan Kubb - -dnm: Justin Wheeler - -dpetrov: Dimitar Petrov +=head1 HOW TO CONTRIBUTE -dwc: Daniel Westermann-Clark +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. -dyfrgi: Michael Leuchtenburg +=for comment +FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;) -felliott: Fitz Elliott +This project is maintained in a git repository. The code and related tools are +accessible at the following locations: -freetime: Bill Moseley - -frew: Arthur Axel "fREW" Schmidt - -goraxe: Gordon Irving - -gphat: Cory G Watson - -Grant Street Group L - -groditi: Guillermo Roditi - -Haarg: Graham Knop - -hobbs: Andrew Rodland - -ilmari: Dagfinn Ilmari MannsEker - -initself: Mike Baas - -ironcamel: Naveed Massjouni - -jawnsy: Jonathan Yu - -jasonmay: Jason May - -jesper: Jesper Krogh - -jgoulah: John Goulah - -jguenther: Justin Guenther - -jhannah: Jay Hannah - -jnapiorkowski: John Napiorkowski - -jon: Jon Schutz - -jshirley: J. Shirley - -kaare: Kaare Rasmussen - -konobi: Scott McWhirter - -littlesavage: Alexey Illarionov - -lukes: Luke Saunders - -marcus: Marcus Ramberg - -mattlaw: Matt Lawrence - -mattp: Matt Phillips - -michaelr: Michael Reddick - -milki: Jonathan Chu - -ned: Neil de Carteret - -nigel: Nigel Metheringham - -ningu: David Kamholz - -Nniuq: Ron "Quinn" Straight" - -norbi: Norbert Buchmuller - -nuba: Nuba Princigalli - -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 - -Possum: Daniel LeWarne - -quicksilver: Jules Bean - -rafl: Florian Ragwitz - -rainboxx: Matthias Dietrich - -rbo: Robert Bohne - -rbuels: Robert Buels - -rdj: Ryan D Johnson - -ribasushi: Peter Rabbitson - -rjbs: Ricardo Signes - -robkinyon: Rob Kinyon - -Robert Olson - -Roman: Roman Filippov - -Sadrak: Felix Antonius Wilhelm Ostmann - -sc_: Just Another Perl Hacker - -scotty: Scotty Allen - -semifor: Marc Mims - -solomon: Jared Johnson +=over -spb: Stephen Bennett +=item * Official repo: L -Squeeks +=item * Official gitweb: L -sszabo: Stephan Szabo +=item * GitHub mirror: L -talexb: Alex Beamish +=item * Authorized committers: L -tamias: Ronald J Kimball +=item * Travis-CI log: L -teejay : Aaron Trevena +=for html +↪ Stable branch CI status: -Todd Lipcon +=back -Tom Hukins +=head1 AUTHORS -tonvoon: Ton Voon +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. -triode: Pete Gamache +=for comment this line is replaced with the author list at dist-building time -typester: Daisuke Murase +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. -victori: Victor Igumnov +=head1 CAT HERDERS -wdh: Will Hawes +The fine folks nudging the project in a particular direction: -willert: Sebastian Willert +=over -wreis: Wallace Reis +B: Peter Rabbitson +(present day maintenance and controlled evolution) -yrlnry: Mark Jason Dominus +B: Jess Robinson +(lions share of the reference documentation and manuals) -zamolxes: Bogdan Lucaciu +B: Matt S Trout (project founder - +original idea, architecture and implementation) -=head1 COPYRIGHT +=back -Copyright (c) 2005 - 2010 the DBIx::Class L and L -as listed above. +=head1 COPYRIGHT AND LICENSE -=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.