X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=3b591cb1d819201bae5d03ff9dcd447838972be0;hb=11736b4c186bbc10c80f13fdb1eca80b1ff75711;hp=144a495e913f6842bcd4c51a8e4bbe9add0a4c73;hpb=7ae7029a88ae7083d74a690dcad468a0c97ebccc;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 144a495..3b591cb 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -4,183 +4,286 @@ use strict; use warnings; use vars qw($VERSION); -use base qw/DBIx::Class::Componentised Class::Data::Accessor/; +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 mk_classdata { shift->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.05999_04'; +$VERSION = '0.08007'; sub MODIFY_CODE_ATTRIBUTES { - my ($class,$code,@attrs) = @_; - unless ($class->can('__attr_cache')) { - $class->mk_classdata('__attr_cache'); - $class->__attr_cache({}); - } - $class->__attr_cache->{$code} = [@attrs]; - return (); + 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 }; + 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 DESCRIPTION +Create a schema class called DB/Main.pm: -This is an SQL to OO mapper, inspired by the L framework, -and meant to support compability with it, while restructuring the -internals and making it possible to support some new features like -self-joins, distinct, group bys and more. + package DB::Main; + use base qw/DBIx::Class::Schema/; -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. + __PACKAGE__->load_classes(); -The community can be found via - + 1; - Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/ +Create a table class to represent artists, who have many CDs, in DB/Main/Artist.pm: - SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/ + package DB::Main::Artist; + use base qw/DBIx::Class/; - Wiki: http://dbix-class.shadowcatsystems.co.uk/ + __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'); - IRC: irc.perl.org#dbix-class + 1; + +A table class to represent a CD, which belongs to an artist, in DB/Main/CD.pm: -=head1 QUICKSTART + package DB::Main::CD; + use base qw/DBIx::Class/; -If you're using L, and want an easy and fast way of migrating to -DBIx::Class, take a look at L. + __PACKAGE__->load_components(qw/PK::Auto Core/); + __PACKAGE__->table('cd'); + __PACKAGE__->add_columns(qw/ cdid artist title year /); + __PACKAGE__->set_primary_key('cdid'); + __PACKAGE__->belongs_to(artist => 'DB::Main::Artist'); -There are two ways of using DBIx::Class, the "simple" way and the "schema" way. -The "simple" way of using DBIx::Class needs less classes than the "schema" -way but doesn't give you the ability to easily use different database connections. + 1; -Some examples where different database connections are useful are: +Then you can use these classes in your application's code: -different users with different rights -different databases with the same schema. + # Connect to your database. + use DB::Main; + my $schema = DB::Main->connect($dbi_dsn, $user, $pass, \%dbi_params); -=head2 Simple + # 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'); -First you need to create a base class which all other classes will inherit from. -See L for information on how to do this. + # 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%' } } + ); -Then you need to create a class for every table you want to use with DBIx::Class. -See L for information on how to do this. + # Execute a joined query to get the cds. + my @all_john_cds = $johns_rs->search_related('cds')->all; -=head2 Schema + # Fetch only the next row. + my $first_john = $johns_rs->next; -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 that inherits from DBIx::Class::Core and adds additional methods -needed by all table classes, e.g. reading a config file or loading auto primary -key support. + # Specify ORDER BY on the query. + my $first_john_cds_by_title_rs = $first_john->cds( + undef, + { order_by => 'title' } + ); -Look at L for information on how to do this. + # Create a result set that will fetch the artist relationship + # at the same time as it fetches CDs, using only one query. + my $millennium_cds_rs = $schema->resultset('CD')->search( + { year => 2000 }, + { prefetch => 'artist' } + ); -If you need more help, check out the introduction in the -manual below. + 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 -=head1 SEE ALSO + # 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'); -=over 4 + $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction -=item L - DBIC Core Classes + $millennium_cds_rs->update({ year => 2002 }); # Single-query bulk update + +=head1 DESCRIPTION -=item L - User's manual +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 +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. -=item L - L Compat layer +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). -=item 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 +as bugs are found and fixed. -=item L +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. -=item L +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. -=item L - row-level methods +The community can be found via: -=item L - primary key methods + Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/ -=item L - relationships between tables + SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/ -=back + SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/ + + IRC: irc.perl.org#dbix-class + +=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 -Brian Cassidy +aherzog: Adam Herzog -Dan Kubb +andyg: Andy Grundman -Dan Sully +ank: Andres Kievsky -David Kamholz +ash: Ash Berlin -Jules Bean +blblack: Brandon L. Black -Marcus Ramberg +bluefeet: Aran Deltac -Paul Makepeace +captainL: Luke Saunders -CL Kao +castaway: Jess Robinson -Jess Robinson +claco: Christopher H. Laco -Marcus Ramberg +clkao: CL Kao -Will Hawes +da5id: David Jack Olrik -Todd Lipcon +dkubb: Dan Kubb + +dnm: Justin Wheeler + +draven: Marcus Ramberg + +dwc: Daniel Westermann-Clark -Daniel Westermann-Clark +dyfrgi: Michael Leuchtenburg -Alexander Hartmaier +gphat: Cory G Watson -Zbigniew Lukasiak +jesper: Jesper Krogh -Nigel Metheringham +jguenther: Justin Guenther -Jesper Krogh +jnapiorkowski: John Napiorkowski -Brandon Black +jon: Jon Schutz -Christopher H. Laco +jshirley: J. Shirley -Scotty Allen +konobi: Scott McWhirter -sc_ +LTJake: Brian Cassidy -Justin Guenther +mattlaw: Matt Lawrence -Daisuke Murase +ned: Neil de Carteret -Scott McWhirter (konobi) +nigel: Nigel Metheringham + +ningu: David Kamholz + +Numa: Dan Sully + +paulm: Paul Makepeace + +penguin: K J Cheetham + +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 -