X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=2f2be9e75c7205925f280b598b3b81a4583d5015;hb=44736f7776d0b2bedb83994ba370f362226881ab;hp=eafc15a78fe5a3a3a5c33e39f5fbcf5764d0a4fb;hpb=913b4bae66f2a424428ff3bd1e340b42da4581b8;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index eafc15a..2f2be9e 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -11,47 +11,11 @@ our $VERSION; # $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.08206'; +$VERSION = '0.082821'; $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases -BEGIN { - package # hide from pause - DBIx::Class::_ENV_; - - use Config; - - use constant { - - # but of course - BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0, - - HAS_ITHREADS => $Config{useithreads} ? 1 : 0, - - # ::Runmode would only be loaded by DBICTest, which in turn implies t/ - DBICTEST => eval { DBICTest::RunMode->is_author } ? 1 : 0, - - # During 5.13 dev cycle HELEMs started to leak on copy - PEEPEENESS => - # request for all tests would force "non-leaky" illusion and vice-versa - defined $ENV{DBICTEST_ALL_LEAKS} ? !$ENV{DBICTEST_ALL_LEAKS} - # otherwise confess that this perl is busted ONLY on smokers - : eval { DBICTest::RunMode->is_smoker } && ($] >= 5.013005 and $] <= 5.013006) ? 1 - # otherwise we are good - : 0 - , - }; - - if ($] < 5.009_005) { - require MRO::Compat; - constant->import( OLD_MRO => 1 ); - } - else { - require mro; - constant->import( OLD_MRO => 0 ); - } -} - +use DBIx::Class::_Util; use mro 'c3'; use DBIx::Class::Optional::Dependencies; @@ -63,6 +27,13 @@ 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'); +# FIXME - this is not really necessary, and is in +# fact going to slow things down a bit +# However it is the right thing to do in order to get +# various install bases to highlight their brokenness +# Remove at some unknown point in the future +sub DESTROY { &DBIx::Class::_Util::detected_reinvoked_destructor } + sub mk_classdata { shift->mk_classaccessor(@_); } @@ -93,55 +64,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 * IRC: irc.perl.org#dbix-class =for html -(click for instant chatroom login) +(click for instant chatroom login) =item * Mailing list: L -=item * Twitter L +=item * RT Bug Tracker: L -=item * Web Site: L +=item * Twitter: L -=item * RT Bug Tracker: L +=item * Web Site: L =back -The project is maintained in a git repository, accessible from the following sources: - -=over - -=item * git: L - -=item * gitweb: L - -=item * github mirror: L - -=item * authorized committers: L +=head1 SYNOPSIS -=item * Travis-CI log: L +For the very impatient: L -=for html - +This code in the next step can be generated automatically from an existing +database, see L from the distribution C. -=back - -=head1 SYNOPSIS +=head2 Schema classes preparation -Create a schema class called MyApp/Schema.pm: +Create a schema class called F: package MyApp::Schema; use base qw/DBIx::Class::Schema/; @@ -151,7 +131,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. @@ -166,7 +146,7 @@ See L for docs on defining result classes. 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/; @@ -179,6 +159,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. @@ -247,7 +229,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 @@ -260,8 +243,8 @@ 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 @@ -273,272 +256,79 @@ 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 - -alexrj: Alessandro Ranellucci - -alnewkirk: Al Newkirk - -amiri: Amiri Barksdale - -amoore: Andrew Moore - -andrewalker: Andre Walker - -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 - -brd: Brad Davis - -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 - -dwc: Daniel Westermann-Clark - -dyfrgi: Michael Leuchtenburg +=head1 HOW TO CONTRIBUTE -edenc: Eden Cardim +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. -felliott: Fitz Elliott +=for comment +FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;) -freetime: Bill Moseley +This project is maintained in a git repository. The code and related tools are +accessible at the following locations: -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 - -jmac: Jason McIntosh - -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 - -mjemmeson: Michael Jemmeson - -mstratman: Mark A. Stratman - -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: Eystein Torget - -paulm: Paul Makepeace - -penguin: K J Cheetham - -perigrin: Chris Prather - -peter: Peter Collingbourne - -Peter Valdemar MErch - -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 - -moltar: Roman Filippov - -Sadrak: Felix Antonius Wilhelm Ostmann - -sc_: Just Another Perl Hacker - -scotty: Scotty Allen - -semifor: Marc Mims - -SineSwiper: Brendan Byrd - -solomon: Jared Johnson - -spb: Stephen Bennett - -Squeeks +=over -sszabo: Stephan Szabo +=item * Official repo: L -talexb: Alex Beamish +=item * Official gitweb: L -tamias: Ronald J Kimball +=item * GitHub mirror: L -teejay : Aaron Trevena +=item * Authorized committers: L -Todd Lipcon +=item * Travis-CI log: L -Tom Hukins +=for html +↪ Main dev branch CI status: +↪ Release branch CI status: -tonvoon: Ton Voon +=back -triode: Pete Gamache +=head1 AUTHORS -typester: Daisuke Murase +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. -victori: Victor Igumnov +=for comment this line is replaced with the author list at dist-building time -wdh: Will Hawes +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. -wesm: Wes Malone +=head1 CAT HERDERS -willert: Sebastian Willert +The fine folks nudging the project in a particular direction: -wreis: Wallace Reis +=over -xenoterracide: Caleb Cushing +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 - 2011 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.