X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=b6a089c4df341ce1265aa486ec43f5dd2265d321;hb=cebfddb3f2a7b76b82e76bf24292ad5b46ab764b;hp=766976a204d00de0a4543d956d81b3a4ea60f7f9;hpb=f183eccd611133789a4f03bafde6a7e8979b26ff;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 766976a..b6a089c 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -13,11 +13,12 @@ sub component_base_class { 'DBIx::Class' } # 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.07000'; sub MODIFY_CODE_ATTRIBUTES { my ($class,$code,@attrs) = @_; - $class->mk_classdata('__attr_cache' => {}) unless $class->can('__attr_cache'); + $class->mk_classdata('__attr_cache' => {}) + unless $class->can('__attr_cache'); $class->__attr_cache->{$code} = [@attrs]; return (); } @@ -31,114 +32,128 @@ sub _attr_cache { 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' }); - + 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 +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. +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 - +The community can be found via: Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/ @@ -150,83 +165,72 @@ The community can be found via - =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 +L lists each task you might want help on, and +the modules where you will find documentation. -=item L - encapsulates a query and its results +=head1 AUTHOR -=item L - row-level methods +mst: Matt S. Trout -=item L - primary key methods +=head1 CONTRIBUTORS -=item L - relationships between tables +abraxxa: Alexander Hartmaier -=back +andyg: Andy Grundman -=head1 AUTHOR +ank: Andres Kievsky -Matt S. Trout +blblack: Brandon L. Black -=head1 CONTRIBUTORS +bluefeet: Aran Deltac -Alexander Hartmaier +LTJake: Brian Cassidy -Andy Grundman +claco: Christopher H. Laco -Andres Kievsky +clkao: CL Kao -Brandon Black +typester: Daisuke Murase -Brian Cassidy +dkubb: Dan Kubb -Christopher H. Laco +Numa: Dan Sully -CL Kao +dwc: Daniel Westermann-Clark -Daisuke Murase +ningu: David Kamholz -Dan Kubb +jesper: Jesper Krogh -Dan Sully +castaway: Jess Robinson -Daniel Westermann-Clark +quicksilver: Jules Bean -David Kamholz +jguenther: Justin Guenther -Jesper Krogh +captainL: Luke Saunders -Jess Robinson +draven: Marcus Ramberg -Jules Bean +nigel: Nigel Metheringham -Justin Guenther +paulm: Paul Makepeace -Marcus Ramberg +phaylon: Robert Sedlacek -Nigel Metheringham +sc_: Just Another Perl Hacker -Paul Makepeace +konobi: Scott McWhirter -Robert Sedlacek +scotty: Scotty Allen -sc_ of irc.perl.org#dbix-class - -Scott McWhirter (konobi) - -Scotty Allen +sszabo: Stephan Szabo Todd Lipcon -Will Hawes +wdh: Will Hawes + +gphat: Cory G Watson =head1 LICENSE