X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=75eb74f978f3edfea1ffce22d44ffbc11173dd2f;hb=bc0c980086ba429cf33b1d471d1035601727231f;hp=83064ceca5c7c8d80d9c04d241264e90a0dc635a;hpb=fab31d8c753ec27ee5b5a16d1568cc337a245858;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 83064ce..75eb74f 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -4,30 +4,152 @@ use strict; use warnings; use vars qw($VERSION); -use base qw/DBIx::Class::Componentised/; +use base qw/DBIx::Class::Componentised Class::Data::Accessor/; -$VERSION = '0.03'; +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'; + +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 -DBIx::Class - Because the brain is a terrible thing to waste. +DBIx::Class - Extensible and flexible object <-> relational mapper. =head1 SYNOPSIS -=head1 DESCRIPTION +Create a base schema class called DB/Main.pm: + + package DB::Main; + use base qw/DBIx::Class::Schema/; + + __PACKAGE__->load_classes(); + + 1; + +Create a class the 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'); + + 1; + +A 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'); + + 1; + +Then you can use these classes in your application's code: + + # Connect to your database. + my $ds = DB::Main->connect(@dbi_dsn); + + # Query for all artists and put them in an array, + # or retrieve them as a result set object. + my @all_artists = $ds->resultset('Artist')->all; + my $all_artists_rs = $ds->resultset('Artist'); + + # Create a result set to search for artists. + # This does not query the DB, yet. + my $johns_rs = $ds->resultset('Artist')->search( + # Build your WHERE using an SQL::Abstract structure: + { 'name' => { 'like', 'John%' } } + ); + + # Now the query is executed. + my @all_john_cds = $johns_rs->search_related('cds')->all; + + # Queries but only fetches one row so far. + my $first_john = $johns_rs->next; + + my $first_john_cds_by_title_rs = $first_john->cds( + undef, + { order_by => 'title' } + ); + + my $millenium_cds_rs = $ds->resultset('CD')->search( + { year => 2000 }, + { prefetch => 'artist' } + ); + + my $cd = $millenium_cds_rs->next; # SELECT ... FROM cds JOIN artists ... + my $cd_artist_name = $cd->artist->name; # Already has the data so no query -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. + my $new_cd = $ds->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'); -It's currently considered EXPERIMENTAL - bring this near a production -database at your own risk! The API is *not* fixed yet, although most of -the primitives should be good for the future and any API changes will be -posted to the mailing list before they're committed. + $ds->txn_do(sub { $new_cd->update }); # Runs the update in a transaction + + $millenium_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 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. + +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). + +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. + +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. The community can be found via - @@ -39,34 +161,29 @@ The community can be found via - IRC: irc.perl.org#dbix-class -=head1 QUICKSTART +=head1 WHERE TO GO NEXT -If you're using Class::DBI, replacing +=over 4 - use base qw/Class::DBI/; +=item L - user's manual -with +=item L - DBIC Core Classes - use base qw/DBIx::Class/; - __PACKAGE__->load_components(qw/CDBICompat Core DB/); +=item L - L Compat layer -will probably get you started. +=item L - schema and connection container -If you're using AUTO_INCREMENT for your primary columns, you'll also want -yo load the approriate PK::Auto subclass - e.g. +=item L - tables and table-like things - __PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core DB/); +=item L - encapsulates a query and its results -(with is what ::Test::SQLite does to present the Class::DBI::Test::SQLite -interface) +=item L - row-level methods -If you fancy playing around with DBIx::Class from scratch, then read the docs -for ::Table and ::Relationship, +=item L - primary key methods - use base qw/DBIx::Class/; - __PACKAGE__->load_components(qw/Core DB/); +=item L - relationships between tables -and have a look at t/lib/DBICTest.pm for a brief example. +=back =head1 AUTHOR @@ -74,18 +191,56 @@ Matt S. Trout =head1 CONTRIBUTORS +Alexander Hartmaier + Andy Grundman +Andres Kievsky + +Brandon Black + Brian Cassidy +Christopher H. Laco + +CL Kao + +Daisuke Murase + Dan Kubb Dan Sully -davekam +Daniel Westermann-Clark + +David Kamholz + +Jesper Krogh + +Jess Robinson + +Jules Bean + +Justin Guenther Marcus Ramberg +Nigel Metheringham + +Paul Makepeace + +Robert Sedlacek + +sc_ of irc.perl.org#dbix-class + +Scott McWhirter (konobi) + +Scotty Allen + +Todd Lipcon + +Will Hawes + =head1 LICENSE You may distribute this code under the same terms as Perl itself.