X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=ba237a2ee5127d619c753fddd4c5a29df9c441a1;hb=75cbf825304bd394c21e9cc5635cead3a9550580;hp=b2c38d1e6bea85cdf7d3ba5411b2522eebd3f9e4;hpb=86a23587c7464cf3768f75a0a295155fbf4b9afe;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index b2c38d1..ba237a2 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -11,57 +11,18 @@ 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.08204'; +$VERSION = '0.08270'; $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 - , - - # There was a brief period of p5p insanity when $@ was invisible in a DESTROY - INVISIBLE_DOLLAR_AT => ($] >= 5.013001 and $] <= 5.013007) ? 1 : 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; 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'); @@ -98,48 +59,56 @@ sub _attr_cache { 1; +__END__ + +=encoding UTF-8 + =head1 NAME DBIx::Class - Extensible and flexible object <-> relational mapper. -=head1 GETTING HELP/SUPPORT +=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. -The community can be found via: +=head1 HOW TO GET HELP + +Due to the complexity 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 the community with your questions. The +list below 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 +=head1 SYNOPSIS -=item * authorized committers: L +For the very impatient: L -=back +This code in the next step can be generated automatically from an existing +database, see L from the distribution C. -=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/; @@ -149,7 +118,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. @@ -164,7 +133,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/; @@ -177,6 +146,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. @@ -225,7 +196,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); @@ -245,7 +216,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 @@ -258,8 +230,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 @@ -271,10 +243,37 @@ 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 +=head1 HOW TO CONTRIBUTE + +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 full access to the official repository after their first patch +passes successful review. + +=for comment +FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;) + +This project is maintained in a git repository. The code and related tools are +accessible at the following locations: + +=over + +=item * Official repo: L + +=item * Official gitweb: L + +=item * GitHub mirror: L + +=item * Authorized committers: L + +=item * Travis-CI log: L -L lists each task you might want help on, and -the modules where you will find documentation. +=for html +↪ Stable branch CI status: + +=back =head1 AUTHOR @@ -301,6 +300,8 @@ amiri: Amiri Barksdale amoore: Andrew Moore +andrewalker: Andre Walker + andyg: Andy Grundman ank: Andres Kievsky @@ -311,7 +312,7 @@ arcanez: Justin Hunter ash: Ash Berlin -bert: Norbert Csongradi +bert: Norbert Csongrádi blblack: Brandon L. Black @@ -339,6 +340,12 @@ clkao: CL Kao da5id: David Jack Olrik +dariusj: Darius Jokilehto + +davewood: David Schmidt + +daxim: Lars Dɪᴇᴄᴋᴏᴡ 迪拉斯 + debolaz: Anders Nor Berle dew: Dan Thomas @@ -355,6 +362,8 @@ dyfrgi: Michael Leuchtenburg edenc: Eden Cardim +ether: Karen Etheridge + felliott: Fitz Elliott freetime: Bill Moseley @@ -391,6 +400,8 @@ jguenther: Justin Guenther jhannah: Jay Hannah +jmac: Jason McIntosh + jnapiorkowski: John Napiorkowski jon: Jon Schutz @@ -415,6 +426,8 @@ michaelr: Michael Reddick milki: Jonathan Chu +mithaldu: Christian Walde + mjemmeson: Michael Jemmeson mstratman: Mark A. Stratman @@ -445,6 +458,8 @@ perigrin: Chris Prather peter: Peter Collingbourne +Peter Siklósi + Peter Valdemar MErch phaylon: Robert Sedlacek @@ -473,7 +488,7 @@ robkinyon: Rob Kinyon Robert Olson -Roman: Roman Filippov +moltar: Roman Filippov Sadrak: Felix Antonius Wilhelm Ostmann @@ -525,6 +540,8 @@ yrlnry: Mark Jason Dominus zamolxes: Bogdan Lucaciu +Zefram: Andrew Main + =head1 COPYRIGHT Copyright (c) 2005 - 2011 the DBIx::Class L and L @@ -534,5 +551,3 @@ as listed above. This library is free software and may be distributed under the same terms as perl itself. - -=cut