X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=9147f464c673ca827220c015a7abfb1084bae9cc;hb=0da8b7da7a9df7b84e9a3228cd1f5feb1d65bb07;hp=766976a204d00de0a4543d956d81b3a4ea60f7f9;hpb=f183eccd611133789a4f03bafde6a7e8979b26ff;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 766976a..9147f46 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -4,233 +4,298 @@ 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.08010'; sub MODIFY_CODE_ATTRIBUTES { - my ($class,$code,@attrs) = @_; - $class->mk_classdata('__attr_cache' => {}) unless $class->can('__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 -DB/Main.pm: +Create a schema class called DB/Main.pm: - package DB::Main; - use base qw/DBIx::Class::Schema/; - __PACKAGE__->load_classes(); + package DB::Main; + use base qw/DBIx::Class::Schema/; - 1; + __PACKAGE__->load_classes(); + 1; -DB/Main/Artist.pm: +Create a table class to represent artists, who have many CDs, in DB/Main/Artist.pm: - package DB::Main::Artist; - use base qw/DBIx::Class/; - __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 DB::Main::Artist; + use base qw/DBIx::Class/; - 1; + __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'); + 1; -DB/Main/CD.pm: +A table class to represent a CD, which belongs to an artist, in DB/Main/CD.pm: - package DB::Main::CD; - use base qw/DBIx::Class/; - __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'); + package DB::Main::CD; + use base qw/DBIx::Class/; - 1; + __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'); -in application code: + 1; - my $ds = DB::Main->connect(@dbi_dsn); # DBI connect will happen on-demand +Then you can use these classes in your application's code: - my @all_artists = $ds->resultset('Artist')->all; + # Connect to your database. + use DB::Main; + my $schema = DB::Main->connect($dbi_dsn, $user, $pass, \%dbi_params); - my $johns_rs = $ds->resultset('Artist')->search( - { 'name' => { 'like', 'John%' } }); # Doesn't query the db + # 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'); - my @all_john_cds = $johns_rs->search_related('cds')->all; # Now it queries + # 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%' } } + ); - my $first_john = $johns_rs->next; # Queries but only fetches one row so far + # Execute a joined query to get the cds. + my @all_john_cds = $johns_rs->search_related('cds')->all; - my $first_john_cds_by_title_rs = $first_john->cds(undef, - { order_by => 'title' }); + # Fetch only the next row. + my $first_john = $johns_rs->next; - my $millenium_cds_rs = $ds->resultset('CD')->search( - { year => 2000 }, - { prefetch => 'artist' } ); + # Specify ORDER BY on the query. + my $first_john_cds_by_title_rs = $first_john->cds( + undef, + { order_by => 'title' } + ); - my $cd = $millenium_cds_rs->next; # SELECT ... FROM cds JOIN artists ... + # 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' } + ); + 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 $new_cd = $ds->resultset('CD')->new({ title => 'Spoon' }); - + # 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'); - $ds->txn_do(sub { $new_cd->update }); # Runs the update in a transaction + $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction - $millenium_cds_rs->update({ year => 2002 }); # Single-query bulk update + $millennium_cds_rs->update({ year => 2002 }); # Single-query bulk update =head1 DESCRIPTION This is an SQL to OO mapper with an object API inspired by L -(and a compability layer as a springboard for porting) and a resultset API +(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 mant of the capabilities of the database as possible, +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. 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 when it actually needs to in order to return something the user's -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). +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 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. +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. -Even so, we do your 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 now fairly substantial and several developer releases are -generally made to CPAN before the -current branch is merged back to trunk. +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 community can be found via - +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. - Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/ +The community can be found via: - SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/ + Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/ - Wiki: http://dbix-class.shadowcatsystems.co.uk/ + SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/ + + SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/ IRC: irc.perl.org#dbix-class =head1 WHERE TO GO NEXT -=over 4 +L lists each task you might want help on, and +the modules where you will find documentation. -=item L - User's manual +=head1 AUTHOR -=item L - DBIC Core Classes +mst: Matt S. Trout -=item L - L Compat layer +(I mostly consider myself "project founder" these days but the AUTHOR heading +is traditional :) -=item L - schema and connection container +=head1 CONTRIBUTORS -=item L - tables and table-like things +abraxxa: Alexander Hartmaier -=item L - encapsulates a query and its results +aherzog: Adam Herzog -=item L - row-level methods +andyg: Andy Grundman -=item L - primary key methods +ank: Andres Kievsky -=item L - relationships between tables +ash: Ash Berlin -=back +bert: Norbert Csongradi -=head1 AUTHOR +blblack: Brandon L. Black -Matt S. Trout +bluefeet: Aran Deltac -=head1 CONTRIBUTORS +captainL: Luke Saunders + +castaway: Jess Robinson + +claco: Christopher H. Laco + +clkao: CL Kao -Alexander Hartmaier +da5id: David Jack Olrik -Andy Grundman +debolaz: Anders Nor Berle -Andres Kievsky +dkubb: Dan Kubb -Brandon Black +dnm: Justin Wheeler -Brian Cassidy +draven: Marcus Ramberg -Christopher H. Laco +dwc: Daniel Westermann-Clark -CL Kao +dyfrgi: Michael Leuchtenburg -Daisuke Murase +gphat: Cory G Watson -Dan Kubb +jesper: Jesper Krogh -Dan Sully +jguenther: Justin Guenther -Daniel Westermann-Clark +jnapiorkowski: John Napiorkowski -David Kamholz +jon: Jon Schutz -Jesper Krogh +jshirley: J. Shirley -Jess Robinson +konobi: Scott McWhirter -Jules Bean +LTJake: Brian Cassidy -Justin Guenther +mattlaw: Matt Lawrence -Marcus Ramberg +ned: Neil de Carteret -Nigel Metheringham +nigel: Nigel Metheringham -Paul Makepeace +ningu: David Kamholz -Robert Sedlacek +Numa: Dan Sully -sc_ of irc.perl.org#dbix-class +oyse: Øystein Torget -Scott McWhirter (konobi) +paulm: Paul Makepeace -Scotty Allen +penguin: K J Cheetham + +perigrin: Chris Prather + +phaylon: Robert Sedlacek + +quicksilver: Jules Bean + +rdj: Ryan D Johnson + +sc_: Just Another Perl Hacker + +scotty: Scotty Allen + +semifor: Marc Mims + +sszabo: Stephan Szabo + +teejay : Aaron Trevena Todd Lipcon -Will Hawes +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 -