X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=ef0717dd82cd9bf104c694aae0075e59b223f3a2;hb=06752a03d716bf4b257c448b07cccae4ca519e13;hp=032f79d0a1850992ba35794103017eb3bf1e8b86;hpb=e3194e31ae2f6047668d453f958d32f2a67ba6d8;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 032f79d..ef0717d 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -3,14 +3,65 @@ 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.08209'; + +$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 mro 'c3'; use DBIx::Class::Optional::Dependencies; -use vars qw($VERSION); -use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/; +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(@_); @@ -24,13 +75,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.08123_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' => {}) @@ -55,9 +99,20 @@ sub _attr_cache { 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. + +=head1 HOW TO GET HELP -The community can be found via: +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 @@ -70,17 +125,49 @@ The community can be found via: =item * RT Bug Tracker: L -=item * gitweb: L +=item * Twitter: L + +=item * Web Site: L + +=back + +=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 * git: L +=item * authorized committers: L + +=item * Travis-CI log: L + +=for html +
↪ Stable branch CI status: =back =head1 SYNOPSIS -Create a schema class called MyDB/Schema.pm: +Create a schema class called MyApp/Schema.pm: - package MyDB::Schema; + package MyApp::Schema; use base qw/DBIx::Class::Schema/; __PACKAGE__->load_namespaces(); @@ -88,39 +175,39 @@ 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: +MyApp/Schema/Result/Artist.pm: 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: +MyApp/Schema/Result/CD.pm: - 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; 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. @@ -164,7 +251,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); @@ -193,7 +280,8 @@ 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. @@ -209,11 +297,6 @@ 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 @@ -225,16 +308,28 @@ is traditional :) 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 @@ -245,14 +340,20 @@ 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 @@ -261,6 +362,8 @@ clkao: CL Kao da5id: David Jack Olrik +davewood: David Schmidt + debolaz: Anders Nor Berle dew: Dan Thomas @@ -275,12 +378,20 @@ dwc: Daniel Westermann-Clark dyfrgi: Michael Leuchtenburg +edenc: Eden Cardim + +felliott: Fitz Elliott + +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 @@ -289,6 +400,12 @@ hobbs: Andrew Rodland ilmari: Dagfinn Ilmari MannsEker +initself: Mike Baas + +ironcamel: Naveed Massjouni + +jawnsy: Jonathan Yu + jasonmay: Jason May jesper: Jesper Krogh @@ -299,22 +416,38 @@ 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 + +mithaldu: Christian Walde + +mjemmeson: Michael Jemmeson + +mstratman: Mark A. Stratman + ned: Neil de Carteret nigel: Nigel Metheringham @@ -331,7 +464,7 @@ Numa: Dan Sully ovid: Curtis "Ovid" Poe -oyse: Øystein Torget +oyse: Eystein Torget paulm: Paul Makepeace @@ -341,6 +474,8 @@ perigrin: Chris Prather peter: Peter Collingbourne +Peter Valdemar MErch + phaylon: Robert Sedlacek plu: Johannes Plunien @@ -365,7 +500,11 @@ rjbs: Ricardo Signes robkinyon: Rob Kinyon -Roman: Roman Filippov +Robert Olson + +moltar: Roman Filippov + +Sadrak: Felix Antonius Wilhelm Ostmann sc_: Just Another Perl Hacker @@ -373,12 +512,20 @@ scotty: Scotty Allen semifor: Marc Mims +SineSwiper: Brendan Byrd + solomon: Jared Johnson spb: Stephen Bennett +Squeeks + sszabo: Stephan Szabo +talexb: Alex Beamish + +tamias: Ronald J Kimball + teejay : Aaron Trevena Todd Lipcon @@ -395,15 +542,21 @@ victori: Victor Igumnov wdh: Will Hawes +wesm: Wes Malone + willert: Sebastian Willert wreis: Wallace Reis +xenoterracide: Caleb Cushing + +yrlnry: Mark Jason Dominus + zamolxes: Bogdan Lucaciu =head1 COPYRIGHT -Copyright (c) 2005 - 2010 the DBIx::Class L and L +Copyright (c) 2005 - 2011 the DBIx::Class L and L as listed above. =head1 LICENSE