X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=cdcbcbbefd824cc028a97d4ba3c3f27bebed97a8;hb=7305f6f933813eaa1a4a7b65bfc5f158d0d65c4d;hp=d6987196e562d30be42b8becdb244536677c942c;hpb=58755bbaee2ccf9eb6e9d03b9e8a8a79aeda2ebe;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index d698719..cdcbcbb 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -1,116 +1,157 @@ package DBIx::Class; +# important to load early +use DBIx::Class::_Util; + use strict; use warnings; -use vars qw($VERSION); -use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/; -use DBIx::Class::StartupCheck; - - -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' } - +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 = '0.08099_06'; +# $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.082899_25'; -$VERSION = eval $VERSION; # numify for warning-free dev releases +$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases -sub MODIFY_CODE_ATTRIBUTES { - my ($class,$code,@attrs) = @_; - $class->mk_classdata('__attr_cache' => {}) - unless $class->can('__attr_cache'); - $class->__attr_cache->{$code} = [@attrs]; - return (); -} +use mro 'c3'; -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 }; +use base qw/DBIx::Class::Componentised DBIx::Class::AccessorGroup/; + +__PACKAGE__->mk_classaccessor( + _skip_namespace_frames => join( '|', map { '^' . $_ } qw( + DBIx::Class + SQL::Abstract + SQL::Translator + Try::Tiny + Class::Accessor::Grouped + Context::Preserve + Moose::Meta:: + )), +); + +sub component_base_class { 'DBIx::Class' } + +# *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 -The community can be found via: +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"): - Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/ +=over - SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/ +=item * IRC: irc.perl.org#dbix-class - SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/ +=for html +(click for instant chatroom login) - IRC: irc.perl.org#dbix-class +=item * Mailing list: L + +=item * RT Bug Tracker: 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(); 1; -Create a table class to represent artists, who have many CDs, in -MyDB/Schema/Result/Artist.pm: +Create a result class to represent artists, who have many CDs, in +F: - package MyDB::Schema::Result::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/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 table class to represent a CD, which belongs to an artist, in -MyDB/Schema/Result/CD.pm: +A result class to represent a CD, which belongs to an artist, in +F: - package MyDB::Schema::Result::CD; - use base qw/DBIx::Class/; + package MyApp::Schema::Result::CD; + use base qw/DBIx::Class::Core/; - __PACKAGE__->load_components(qw/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; +=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. + # $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( @@ -140,7 +181,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 doesn't 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); @@ -160,7 +201,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 @@ -169,11 +211,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 @@ -185,144 +228,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. -=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 - -(I mostly consider myself "project founder" these days but the AUTHOR heading -is traditional :) - -=head1 CONTRIBUTORS - -abraxxa: Alexander Hartmaier - -aherzog: Adam Herzog - -andyg: Andy Grundman +=head1 HOW TO CONTRIBUTE -ank: Andres Kievsky +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. -ash: Ash Berlin +=for comment +FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;) -bert: Norbert Csongradi +This project is maintained in a git repository. The code and related tools are +accessible at the following locations: -blblack: Brandon L. Black +=over -bluefeet: Aran Deltac +=item * Official repo: L -bricas: Brian Cassidy +=item * Official gitweb: L -caelum: Rafael Kitover +=item * GitHub mirror: L -captainL: Luke Saunders +=item * Authorized committers: L -castaway: Jess Robinson +=item * Travis-CI log: L -claco: Christopher H. Laco +=for html +↪ Bleeding edge dev CI status: -clkao: CL Kao +=back -da5id: David Jack Olrik +=head1 AUTHORS -debolaz: Anders Nor Berle +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. -dkubb: Dan Kubb +=for comment this line is replaced with the author list at dist-building time -dnm: Justin Wheeler +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. -dwc: Daniel Westermann-Clark +=head1 CAT HERDERS -dyfrgi: Michael Leuchtenburg +The fine folks nudging the project in a particular direction: -gphat: Cory G Watson +=over -groditi: Guillermo Roditi +B: Peter Rabbitson +(present day maintenance and controlled evolution) -jesper: Jesper Krogh +B: Jess Robinson +(lions share of the reference documentation and manuals) -jgoulah: John Goulah +B: Matt S Trout (project founder - +original idea, architecture and implementation) -jguenther: Justin Guenther +=back -jnapiorkowski: John Napiorkowski +=head1 COPYRIGHT AND LICENSE -jon: Jon Schutz +Copyright (c) 2005 by mst, castaway, ribasushi, and other DBIx::Class +L as listed above and in F. -jshirley: J. Shirley - -konobi: Scott McWhirter - -marcus: Marcus Ramberg - -mattlaw: Matt Lawrence - -michaelr: Michael Reddick - -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 - -plu: Johannes Plunien - -quicksilver: Jules Bean - -rafl: Florian Ragwitz - -rdj: Ryan D Johnson - -ribasushi: Peter Rabbitson - -rjbs: Ricardo Signes - -robkinyon: Rob Kinyon - -sc_: Just Another Perl Hacker - -scotty: Scotty Allen - -semifor: Marc Mims - -sszabo: Stephan Szabo - -teejay : Aaron Trevena - -Todd Lipcon - -Tom Hukins - -typester: Daisuke Murase - -victori: Victor Igumnov - -wdh: Will Hawes - -willert: Sebastian Willert - -zamolxes: Bogdan Lucaciu - -norbi: Norbert Buchmuller - -=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.