X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=50990168e6346c28eff208eb42da4cb3272c5e7e;hb=7c0825ab81039b5d7f4242523603f60e0fd78575;hp=f1fa595f7bbd2db5f14da60f22b67ff978210a4a;hpb=ccb9c9b1ecb24a558a3e952c5b7e9b33d819b657;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index f1fa595..5099016 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -4,119 +4,313 @@ use strict; use warnings; use vars qw($VERSION); -use base qw/DBIx::Class::Componentised Class::Data::Inheritable/; +use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/; +use DBIx::Class::StartupCheck; -$VERSION = '0.04001'; +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' } + +# 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_04'; + +$VERSION = eval $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 (); +} + +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 }; +} 1; -=head1 NAME +=head1 NAME DBIx::Class - Extensible and flexible object <-> relational mapper. -=head1 SYNOPSIS +=head1 GETTING HELP/SUPPORT -=head1 DESCRIPTION +The community can be found via: -This is a sql to oop mapper, inspired by the L framework, -and meant to support compability with it, while restructuring the -insides, and making it possible to support some new features like -self-joins, distinct, group bys and more. + Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/ -This project is still at an early stage so the maintainers don't make -any absolute promise that full backwards-compatibility will be supported; -however if we can without compromising the improvements we're trying to -make, we will, and any non-compatible changes will merit a full justification -on the mailing list and a CPAN developer release for people to test against. + SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/ -The community can be found via - + SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/ - Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/ + IRC: irc.perl.org#dbix-class - SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/ +=head1 SYNOPSIS - Wiki: http://dbix-class.shadowcatsystems.co.uk/ +Create a schema class called MyDB/Schema.pm: - IRC: irc.perl.org#dbix-class + package MyDB::Schema; + use base qw/DBIx::Class::Schema/; -=head1 QUICKSTART + __PACKAGE__->load_classes(); -If you're using Class::DBI, and want an easy and fast way of migrating to -DBIx::Class look at L. + 1; -There are two ways of using DBIx::Class, the 'simple' and the 'schema' one. +Create a table class to represent artists, who have many CDs, in +MyDB/Schema/Artist.pm: -The 'simple' way of using DBIx::Class needs less classes than the 'schema' -way but doesn't give you the ability to use different database connections. + package MyDB::Schema::Artist; + use base qw/DBIx::Class/; -Some examples where different database connections are useful are: + __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::CD'); -different users with different rights -different databases with the same schema. + 1; -=head1 Simple +A table class to represent a CD, which belongs to an artist, in +MyDB/Schema/CD.pm: -First you need to create a base class all other classes inherit from. + package MyDB::Schema::CD; + use base qw/DBIx::Class/; -Look at L how to do this + __PACKAGE__->load_components(qw/Core/); + __PACKAGE__->table('cd'); + __PACKAGE__->add_columns(qw/ cdid artistid title year /); + __PACKAGE__->set_primary_key('cdid'); + __PACKAGE__->belongs_to(artist => 'MyDB::Schema::Artist', 'artistid'); -Next you need to create a class for every table you want to use with -DBIx::Class. + 1; -Look at L how to do this. +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); -=head2 Schema + # Query for all artists and put them in an array, + # or retrieve them as a result set object. + my @all_artists = $schema->resultset('Artist')->all; + my $all_artists_rs = $schema->resultset('Artist'); -With this approach the table classes inherit directly from DBIx::Class::Core, -although it might be a good idea to create a 'parent' class for all table -classes which inherits from DBIx::Class::Core and adds additional methods -needed by all table classes, e.g. reading a config file, loading auto primary -key support. + # Create a result set to search for artists. + # This does not query the DB. + my $johns_rs = $schema->resultset('Artist')->search( + # Build your WHERE using an SQL::Abstract structure: + { name => { like => 'John%' } } + ); -Look at L how to do this. + # Execute a joined query to get the cds. + my @all_john_cds = $johns_rs->search_related('cds')->all; -If you need more hand-holding, check out the introduction in the -manual below. + # Fetch only the next row. + my $first_john = $johns_rs->next; -=head1 SEE ALSO + # Specify ORDER BY on the query. + my $first_john_cds_by_title_rs = $first_john->cds( + undef, + { order_by => 'title' } + ); -=over 4 + # 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 }, + { prefetch => 'artist' } + ); -=item L - DBIC Core Classes + 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 -=item L - L Compat layer. + # new() makes a DBIx::Class::Row 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 + $new_cd->title('Fork'); -=item L - User's manual. + $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction -=back + # 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 +(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, ORDER BY and HAVING 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 +database in order to return something you've directly asked for. If a +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). + +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 +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. + +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 -Matt S. Trout +mst: Matt S. Trout + +(I mostly consider myself "project founder" these days but the AUTHOR heading +is traditional :) =head1 CONTRIBUTORS -Andy Grundman +abraxxa: Alexander Hartmaier + +aherzog: Adam Herzog + +andyg: Andy Grundman + +ank: Andres Kievsky + +ash: Ash Berlin + +bert: Norbert Csongradi + +blblack: Brandon L. Black + +bluefeet: Aran Deltac + +bricas: Brian Cassidy + +captainL: Luke Saunders + +castaway: Jess Robinson + +claco: Christopher H. Laco + +clkao: CL Kao + +da5id: David Jack Olrik + +debolaz: Anders Nor Berle + +dkubb: Dan Kubb + +dnm: Justin Wheeler -Brian Cassidy +dwc: Daniel Westermann-Clark -Dan Kubb +dyfrgi: Michael Leuchtenburg -Dan Sully +gphat: Cory G Watson -David Kamholz +groditi: Guillermo Roditi -Jules Bean +jesper: Jesper Krogh -Marcus Ramberg +jgoulah: John Goulah -Paul Makepeace +jguenther: Justin Guenther + +jnapiorkowski: John Napiorkowski + +jon: Jon Schutz + +jshirley: J. Shirley + +konobi: Scott McWhirter + +marcus: Marcus Ramberg + +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 + +rafl: Florian Ragwitz + +rdj: Ryan D Johnson + +ribasushi: Peter Rabbitson + +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 =head1 LICENSE You may distribute this code under the same terms as Perl itself. =cut -