X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=ca0d03bae1ee348bab7271708df9483afbb329db;hb=a6ef93cbf8182ed257e5a5e877835694a23b4e74;hp=6ce93c554cfb3187fd5c2243f440e351a72cfcf0;hpb=1c32fcf0404c47e7cd43de68c9a93792b0d1598a;p=dbsrgits%2FDBIx-Class-Historic.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 6ce93c5..ca0d03b 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -3,22 +3,77 @@ package DBIx::Class; use strict; use warnings; -use vars qw($VERSION); -use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/; +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.08242'; + +$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, -sub mk_classdata { - my $self = shift; - $self->mk_group_accessors('inherited', $_[0]); - $self->set_inherited(@_) if @_ > 1; + 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 ); + } } -sub component_base_class { 'DBIx::Class' } +use mro 'c3'; -# 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 +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'); -$VERSION = '0.07999_01'; +sub mk_classdata { + shift->mk_classaccessor(@_); +} + +sub mk_classaccessor { + my $self = shift; + $self->mk_group_accessors('inherited', $_[0]); + $self->set_inherited(@_) if @_ > 1; +} + +sub component_base_class { 'DBIx::Class' } sub MODIFY_CODE_ATTRIBUTES { my ($class,$code,@attrs) = @_; @@ -31,64 +86,118 @@ sub MODIFY_CODE_ATTRIBUTES { sub _attr_cache { my $self = shift; my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {}; - my $rest = eval { $self->next::method }; - return $@ ? $cache : { %$cache, %$rest }; + + return { + %$cache, + %{ $self->maybe::next::method || {} }, + }; } 1; +__END__ + +=encoding UTF-8 + =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. + +=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) + +=item * Mailing list: L + +=item * RT Bug Tracker: L + +=item * Twitter: L + +=item * Web Site: L + +=back + =head1 SYNOPSIS -Create a schema class called DB/Main.pm: +=head2 Schema classes preparation - package DB::Main; +Create a schema class called F: + + package MyApp::Schema; use base qw/DBIx::Class::Schema/; - __PACKAGE__->load_classes(); + __PACKAGE__->load_namespaces(); 1; -Create a table class to represent artists, who have many CDs, in DB/Main/Artist.pm: +Create a result class to represent artists, who have many CDs, in +F: + +See L for docs on defining result classes. - package DB::Main::Artist; - use base qw/DBIx::Class/; + package MyApp::Schema::Result::Artist; + use base qw/DBIx::Class::Core/; - __PACKAGE__->load_components(qw/PK::Auto Core/); __PACKAGE__->table('artist'); __PACKAGE__->add_columns(qw/ artistid name /); __PACKAGE__->set_primary_key('artistid'); - __PACKAGE__->has_many(cds => 'DB::Main::CD'); + __PACKAGE__->has_many(cds => 'MyApp::Schema::Result::CD', 'artistid'); 1; -A table class to represent a CD, which belongs to an artist, in DB/Main/CD.pm: +A result class to represent a CD, which belongs to an artist, in +F: - package DB::Main::CD; - use base qw/DBIx::Class/; + package MyApp::Schema::Result::CD; + use base qw/DBIx::Class::Core/; - __PACKAGE__->load_components(qw/PK::Auto Core/); + __PACKAGE__->load_components(qw/InflateColumn::DateTime/); __PACKAGE__->table('cd'); - __PACKAGE__->add_columns(qw/ cdid artist title year /); + __PACKAGE__->add_columns(qw/ cdid artistid title year /); __PACKAGE__->set_primary_key('cdid'); - __PACKAGE__->belongs_to(artist => 'DB::Main::Artist'); + __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 DB::Main; - my $schema = DB::Main->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. + # $schema->resultset returns a DBIx::Class::ResultSet my @all_artists = $schema->resultset('Artist')->all; my $all_artists_rs = $schema->resultset('Artist'); + # Output all artists names + # $artist here is a DBIx::Class::Row, which has accessors + # for all its columns. Rows are also subclasses of your Result class. + foreach $artist (@all_artists) { + print $artist->name, "\n"; + } + # Create a result set to search for artists. # This does not query the DB. my $johns_rs = $schema->resultset('Artist')->search( @@ -99,7 +208,7 @@ Then you can use these classes in your application's code: # Execute a joined query to get the cds. my @all_john_cds = $johns_rs->search_related('cds')->all; - # Fetch only the next row. + # Fetch the next available row. my $first_john = $johns_rs->next; # Specify ORDER BY on the query. @@ -108,7 +217,7 @@ Then you can use these classes in your application's code: { order_by => 'title' } ); - # Create a result set that will fetch the artist relationship + # Create a result set that will fetch the artist data # at the same time as it fetches CDs, using only one query. my $millennium_cds_rs = $schema->resultset('CD')->search( { year => 2000 }, @@ -116,8 +225,10 @@ 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 query + my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query + # 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); $new_cd->insert; # Auto-increment primary key filled in after INSERT @@ -125,17 +236,19 @@ Then you can use these classes in your application's code: $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction - $millennium_cds_rs->update({ year => 2002 }); # Single-query bulk update + # change the year of all the millennium CDs at once + $millennium_cds_rs->update({ year => 2002 }); =head1 DESCRIPTION This is an SQL to OO mapper with an object API inspired by L -(and a compatibility layer as a springboard for porting) and a resultset API +(with a compatibility layer as a springboard for porting) and a resultset API 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 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 @@ -144,47 +257,90 @@ 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 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 +APIs, since DBIx::Class is used in production in many organisations, +and even backwards incompatible changes to non-published APIs will be fixed +if they're reported and doing so doesn't cost the codebase anything. -This project is still under rapid development, so features added in the -latest major release may not work 100% yet -- check the Changes if you run -into trouble, and beware of anything explicitly marked EXPERIMENTAL. Failing -test cases are *always* welcome and point releases are put out rapidly as -bugs are found and fixed. +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. -Even so, we do our best to maintain full backwards compatibility for published -APIs, since DBIx::Class is used in production in a number of organisations. -The test suite is quite substantial, and several developer releases are -generally made to CPAN before the -current branch is merged back to trunk for -a major release. +=head1 HOW TO CONTRIBUTE -The community can be found via: +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. - Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/ +=for comment +FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;) - SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/ +This project is maintained in a git repository. The code and related tools are +accessible at the following locations: - Wiki: http://dbix-class.shadowcatsystems.co.uk/ +=over - IRC: irc.perl.org#dbix-class +=item * Official repo: L -=head1 WHERE TO GO NEXT +=item * Official gitweb: L -L lists each task you might want help on, and -the modules where you will find documentation. +=item * GitHub mirror: L + +=item * Authorized committers: L + +=item * Travis-CI log: L + +=for html +↪ Stable branch CI status: + +=back =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 +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 @@ -193,7 +349,19 @@ blblack: Brandon L. Black bluefeet: Aran Deltac -captainL: Luke Saunders +bphillips: Brian Phillips + +boghead: Bryan Beeley + +brd: Brad Davis + +bricas: Brian Cassidy + +brunov: Bruno Vecchi + +caelum: Rafael Kitover + +caldrin: Maik Hentsche castaway: Jess Robinson @@ -201,23 +369,97 @@ claco: Christopher H. Laco clkao: CL Kao +da5id: David Jack Olrik + +dariusj: Darius Jokilehto + +davewood: David Schmidt + +daxim: Lars Dɪᴇᴄᴋᴏᴡ 迪拉斯 + +debolaz: Anders Nor Berle + +dew: Dan Thomas + dkubb: Dan Kubb -draven: Marcus Ramberg +dnm: Justin Wheeler + +dpetrov: Dimitar Petrov 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 + +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 -LTJake: Brian Cassidy +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 @@ -225,36 +467,112 @@ 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 + sszabo: Stephan Szabo +talexb: Alex Beamish + +tamias: Ronald J Kimball + +teejay : Aaron Trevena + Todd Lipcon +Tom Hukins + +tonvoon: Ton Voon + +triode: Pete Gamache + typester: Daisuke Murase 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 LICENSE +=head1 COPYRIGHT -You may distribute this code under the same terms as Perl itself. +Copyright (c) 2005 - 2011 the DBIx::Class L and L +as listed above. + +=head1 LICENSE -=cut +This library is free software and may be distributed under the same terms +as perl itself.