X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=0edcc702d44ef764bc16f2c84f98f30af9c0026e;hb=266bdcc3;hp=47906ff5ae6c5cb2e729e850d413aaa643b2a3a1;hpb=55e2d745a1887534cbcbfe351278d0883dce8ac5;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 47906ff..0edcc70 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -4,79 +4,241 @@ use strict; use warnings; use vars qw($VERSION); -use base; +use base qw/DBIx::Class::Componentised Class::Data::Accessor/; -$VERSION = '0.01'; +sub mk_classdata { shift->mk_classaccessor(@_); } +sub component_base_class { 'DBIx::Class' } -sub load_components { - my $class = shift; - my @comp = map { "DBIx::Class::$_" } grep { $_ !~ /^#/ } @_; - $class->_load_components(@comp); -} +# 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 load_own_components { - my $class = shift; - my @comp = map { "${class}::$_" } grep { $_ !~ /^#/ } @_; - $class->_load_components(@comp); +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 _load_components { - my ($class, @comp) = @_; - foreach my $comp (@comp) { - eval "use $comp"; - die $@ if $@; - } - no strict 'refs'; - unshift(@{"${class}::ISA"}, @comp); +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 +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 that 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. + my $johns_rs = $ds->resultset('Artist')->search( + # Build your WHERE using an SQL::Abstract structure: + { 'name' => { 'like', 'John%' } } + ); + + # This executes a joined query to get the cds + 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 + + 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'); + + $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 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. +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 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 now fairly 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/ + + SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/ + + Wiki: http://dbix-class.shadowcatsystems.co.uk/ + + IRC: irc.perl.org#dbix-class + +=head1 WHERE TO GO NEXT + +=over 4 + +=item L - user's manual + +=item L - DBIC Core Classes + +=item L - L Compat layer + +=item L - schema and connection container + +=item L - tables and table-like things + +=item L - encapsulates a query and its results + +=item L - row-level methods + +=item L - primary key methods + +=item L - relationships between tables + +=back + +=head1 AUTHOR + +mst: Matt S. Trout + +=head1 CONTRIBUTORS + +abraxxa: Alexander Hartmaier + +andyg: Andy Grundman + +ank: Andres Kievsky + +blblack: Brandon Black + +LTJake: Brian Cassidy + +claco: Christopher H. Laco + +clkao: CL Kao + +typester: Daisuke Murase + +dkubb: Dan Kubb + +Numa: Dan Sully + +dwc: Daniel Westermann-Clark -=head1 QUICKSTART +ningu: David Kamholz -If you're using Class::DBI, replacing +jesper: Jesper Krogh -use base qw/Class::DBI/; +castaway: Jess Robinson -with +quicksilver: Jules Bean -use base qw/DBIx::Class/; -__PACKAGE__->load_components(qw/CDBICompat Core DB/); +jguenther: Justin Guenther -will probably get you started. +draven: Marcus Ramberg -If you're using AUTO_INCREMENT for your primary columns, you'll also want -yo load the approriate PK::Auto subclass - e.g. +nigel: Nigel Metheringham -__PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core DB/); +paulm: Paul Makepeace -(with is what ::Test::SQLite does to present the Class::DBI::Test::SQLite -interface) +phaylon: Robert Sedlacek -If you fancy playing around with DBIx::Class from scratch, then read the docs -for ::Table and ::Relationship, +sc_: Just Another Perl Hacker -use base qw/DBIx::Class/; -__PACKAGE__->load_components(qw/Core DB/); +konobi: Scott McWhirter -and have a look at t/lib/DBICTest.pm for a brief example. +scotty: Scotty Allen -=head1 AUTHORS +Todd Lipcon -Matt S. Trout +wdh: Will Hawes =head1 LICENSE