X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=ba237a2ee5127d619c753fddd4c5a29df9c441a1;hb=75cbf825304bd394c21e9cc5635cead3a9550580;hp=86bc9b09943265155bc49c83a6652c5941922101;hpb=db29433c74a98967f61f117bd508c06055db2892;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 86bc9b0..ba237a2 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -3,24 +3,29 @@ package DBIx::Class; use strict; use warnings; -BEGIN { - if ($] < 5.009_005) { - require MRO::Compat; - *DBIx::Class::_ENV_::OLD_MRO = sub () { 1 }; - } - else { - require mro; - *DBIx::Class::_ENV_::OLD_MRO = sub () { 0 }; - } -} +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.08270'; + +$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|^Class::Accessor::Grouped|^Context::Preserve'); sub mk_classdata { shift->mk_classaccessor(@_); @@ -34,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.08127'; - -$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases - sub MODIFY_CODE_ATTRIBUTES { my ($class,$code,@attrs) = @_; $class->mk_classdata('__attr_cache' => {}) @@ -61,40 +59,58 @@ 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 -The community can be found via: +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. -=over +=head1 HOW TO GET HELP -=item * Web Site: L +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 * 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 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(); @@ -102,39 +118,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::Result::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. @@ -178,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); @@ -198,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 @@ -208,11 +227,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 @@ -224,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 -L lists each task you might want help on, and -the modules where you will find documentation. +=item * Official repo: L + +=item * Official gitweb: L + +=item * GitHub mirror: L + +=item * Authorized committers: L + +=item * Travis-CI log: L + +=for html +↪ Stable branch CI status: + +=back =head1 AUTHOR @@ -240,16 +286,22 @@ 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 @@ -260,7 +312,7 @@ arcanez: Justin Hunter ash: Ash Berlin -bert: Norbert Csongradi +bert: Norbert Csongrádi blblack: Brandon L. Black @@ -270,6 +322,8 @@ bphillips: Brian Phillips boghead: Bryan Beeley +brd: Brad Davis + bricas: Brian Cassidy brunov: Bruno Vecchi @@ -286,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 @@ -300,6 +360,12 @@ dwc: Daniel Westermann-Clark dyfrgi: Michael Leuchtenburg +edenc: Eden Cardim + +ether: Karen Etheridge + +felliott: Fitz Elliott + freetime: Bill Moseley frew: Arthur Axel "fREW" Schmidt @@ -308,6 +374,8 @@ goraxe: Gordon Irving gphat: Cory G Watson +Grant Street Group L + groditi: Guillermo Roditi Haarg: Graham Knop @@ -318,6 +386,8 @@ ilmari: Dagfinn Ilmari MannsEker initself: Mike Baas +ironcamel: Naveed Massjouni + jawnsy: Jonathan Yu jasonmay: Jason May @@ -330,6 +400,8 @@ jguenther: Justin Guenther jhannah: Jay Hannah +jmac: Jason McIntosh + jnapiorkowski: John Napiorkowski jon: Jon Schutz @@ -354,6 +426,12 @@ michaelr: Michael Reddick milki: Jonathan Chu +mithaldu: Christian Walde + +mjemmeson: Michael Jemmeson + +mstratman: Mark A. Stratman + ned: Neil de Carteret nigel: Nigel Metheringham @@ -370,7 +448,7 @@ Numa: Dan Sully ovid: Curtis "Ovid" Poe -oyse: Øystein Torget +oyse: Eystein Torget paulm: Paul Makepeace @@ -380,6 +458,10 @@ perigrin: Chris Prather peter: Peter Collingbourne +Peter Siklósi + +Peter Valdemar MErch + phaylon: Robert Sedlacek plu: Johannes Plunien @@ -404,7 +486,9 @@ rjbs: Ricardo Signes robkinyon: Rob Kinyon -Roman: Roman Filippov +Robert Olson + +moltar: Roman Filippov Sadrak: Felix Antonius Wilhelm Ostmann @@ -414,6 +498,8 @@ scotty: Scotty Allen semifor: Marc Mims +SineSwiper: Brendan Byrd + solomon: Jared Johnson spb: Stephen Bennett @@ -442,22 +528,26 @@ 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 +Zefram: Andrew Main + =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 This library is free software and may be distributed under the same terms as perl itself. - -=cut