X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=1e0dc938486a94f9ed3539e663d07f0074291cc7;hb=2b32a0200f177727ed4d28d6bdc70d269226b85f;hp=b2689df5e85bffa4e7b5f7ffabc0ebd017123d3d;hpb=13de943d1aef0b4c2ff28505fc61c90b463302fb;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index b2689df..1e0dc93 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -3,29 +3,42 @@ 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.082800'; + +$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases + +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'); -sub mk_classdata { +sub mk_classdata { shift->mk_classaccessor(@_); } sub mk_classaccessor { my $self = shift; - $self->mk_group_accessors('inherited', $_[0]); + $self->mk_group_accessors('inherited', $_[0]); $self->set_inherited(@_) if @_ > 1; } 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.08010'; - sub MODIFY_CODE_ATTRIBUTES { my ($class,$code,@attrs) = @_; $class->mk_classdata('__attr_cache' => {}) @@ -37,64 +50,129 @@ 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 || {} }, + }; +} + +# *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 + +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) + +=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: +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. + +=head2 Schema classes preparation + +Create a schema class called F: - package DB::Main; + 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: - package DB::Main::Artist; - use base qw/DBIx::Class/; +See L for docs on defining result classes. + + 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( @@ -105,7 +183,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. @@ -114,7 +192,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 }, @@ -122,9 +200,9 @@ 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 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); @@ -133,17 +211,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 @@ -152,11 +232,12 @@ 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. -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 @@ -168,130 +249,78 @@ 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. -The community can be found via: - - Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/ +=head1 HOW TO CONTRIBUTE - SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/ +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. - SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/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 ;) - IRC: irc.perl.org#dbix-class +This project is maintained in a git repository. The code and related tools are +accessible at the following locations: -=head1 WHERE TO GO NEXT +=over -L lists each task you might want help on, and -the modules where you will find documentation. +=item * Official repo: L -=head1 AUTHOR +=item * Official gitweb: L -mst: Matt S. Trout +=item * GitHub mirror: L -(I mostly consider myself "project founder" these days but the AUTHOR heading -is traditional :) +=item * Authorized committers: L -=head1 CONTRIBUTORS +=item * Travis-CI log: L -abraxxa: Alexander Hartmaier +=for html +↪ Stable branch CI status: -aherzog: Adam Herzog +=back -andyg: Andy Grundman +=head1 AUTHORS -ank: Andres Kievsky +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. -ash: Ash Berlin +=for comment this line is replaced with the author list at dist-building time -bert: Norbert Csongradi +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. -blblack: Brandon L. Black +=head1 CAT HERDERS -bluefeet: Aran Deltac +The fine folks nudging the project in a particular direction: -captainL: Luke Saunders +=over -castaway: Jess Robinson +B: Peter Rabbitson +(present day maintenance and controlled evolution) -claco: Christopher H. Laco +B: Jess Robinson +(lions share of the reference documentation and manuals) -clkao: CL Kao +B: Matt S Trout (project founder - +original idea, architecture and implementation) -da5id: David Jack Olrik +=back -debolaz: Anders Nor Berle +=head1 COPYRIGHT AND LICENSE -dkubb: Dan Kubb +Copyright (c) 2005 by mst, castaway, ribasushi, and other DBIx::Class +L as listed above and in F. -dnm: Justin Wheeler - -draven: Marcus Ramberg - -dwc: Daniel Westermann-Clark - -dyfrgi: Michael Leuchtenburg - -gphat: Cory G Watson - -jesper: Jesper Krogh - -jguenther: Justin Guenther - -jnapiorkowski: John Napiorkowski - -jon: Jon Schutz - -jshirley: J. Shirley - -konobi: Scott McWhirter - -LTJake: Brian Cassidy - -mattlaw: Matt Lawrence - -ned: Neil de Carteret - -nigel: Nigel Metheringham - -ningu: David Kamholz - -Numa: Dan Sully - -oyse: Øystein Torget - -paulm: Paul Makepeace - -penguin: K J Cheetham - -perigrin: Chris Prather - -phaylon: Robert Sedlacek - -quicksilver: Jules Bean - -sc_: Just Another Perl Hacker - -scotty: Scotty Allen - -semifor: Marc Mims - -sszabo: Stephan Szabo - -Todd Lipcon - -Tom Hukins - -typester: Daisuke Murase - -victori: Victor Igumnov - -wdh: Will Hawes - -willert: Sebastian Willert - -zamolxes: Bogdan Lucaciu - -=head1 LICENSE - -You may distribute this code under the same terms as Perl itself. - -=cut +This library is free software and may be distributed under the same terms +as perl5 itself. See F for the complete licensing terms.