X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=5bfd5bc966e5a0a8f9149f16a18c8a05195e6629;hb=ef26a3929ebefc93ed94116553cfe3c7280a9579;hp=34b8661d8a2f2a57c818cfcffc19e4ea2a5f5ab3;hpb=7411204b288b1df6416832707a8a6ce11e2ab3d8;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 34b8661..5bfd5bc 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -9,30 +9,151 @@ use base qw/DBIx::Class::Componentised Class::Data::Accessor/; sub mk_classdata { shift->mk_classaccessor(@_); } sub component_base_class { 'DBIx::Class' } -$VERSION = '0.04999_02'; +# 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.06999_03'; + +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 DESCRIPTION +Create a schema class called DB/Main.pm: + + package DB::Main; + use base qw/DBIx::Class::Schema/; + + __PACKAGE__->load_classes(); + + 1; + +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'); + + 1; + +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'); + + 1; + +Then you can use these classes in your application's code: + + # Connect to your database. + use DB::Main; + my $schema = DB::Main->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. + my @all_artists = $schema->resultset('Artist')->all; + my $all_artists_rs = $schema->resultset('Artist'); -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. + # 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%' } } + ); -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. + # Execute a joined query to get the cds. + my @all_john_cds = $johns_rs->search_related('cds')->all; -The community can be found via - + # Fetch only the next row. + my $first_john = $johns_rs->next; + + # Specify ORDER BY on the query. + my $first_john_cds_by_title_rs = $first_john->cds( + undef, + { order_by => 'title' } + ); + + # 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 = $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'); + + $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction + + $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 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 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. + +Even so, we do our 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 quite substantial, and several developer releases are +generally made to CPAN before the -current branch is merged back to trunk for +a major release. + +The community can be found via: Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/ @@ -42,82 +163,74 @@ The community can be found via - IRC: irc.perl.org#dbix-class -=head1 QUICKSTART +=head1 WHERE TO GO NEXT -If you're using L, and want an easy and fast way of migrating to -DBIx::Class, take a look at L. +L lists each task you might want help on, and +the modules where you will find documentation. -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. +=head1 AUTHOR -Some examples where different database connections are useful are: +mst: Matt S. Trout -different users with different rights -different databases with the same schema. +=head1 CONTRIBUTORS -=head2 Simple +abraxxa: Alexander Hartmaier -First you need to create a base class which all other classes will inherit from. -See L for information on how to do this. +andyg: Andy Grundman -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. +ank: Andres Kievsky -=head2 Schema +blblack: Brandon Black -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. +bluefeet: Aran Deltac -Look at L for information on how to do this. +LTJake: Brian Cassidy -If you need more help, check out the introduction in the -manual below. +claco: Christopher H. Laco -=head1 SEE ALSO +clkao: CL Kao -=head2 L - DBIC Core Classes +typester: Daisuke Murase -=head2 L - User's manual +dkubb: Dan Kubb -=head2 L - L Compat layer +Numa: Dan Sully -=head2 L - database-level methods +dwc: Daniel Westermann-Clark -=head2 L - table-level methods +ningu: David Kamholz -=head2 L - row-level methods +jesper: Jesper Krogh -=head2 L - primary key methods +castaway: Jess Robinson -=head2 L - search result-set methods +quicksilver: Jules Bean -=head2 L - relationships between tables +jguenther: Justin Guenther -=head1 AUTHOR +captainL: Luke Saunders -Matt S. Trout +draven: Marcus Ramberg -=head1 CONTRIBUTORS +nigel: Nigel Metheringham + +paulm: Paul Makepeace -Andy Grundman +phaylon: Robert Sedlacek -Brian Cassidy +sc_: Just Another Perl Hacker -Dan Kubb +konobi: Scott McWhirter -Dan Sully +scotty: Scotty Allen -David Kamholz +sszabo: Stephan Szabo -Jules Bean +Todd Lipcon -Marcus Ramberg +wdh: Will Hawes -Paul Makepeace +gphat: Cory G Watson =head1 LICENSE