X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=5bfd5bc966e5a0a8f9149f16a18c8a05195e6629;hb=ef26a3929ebefc93ed94116553cfe3c7280a9579;hp=f78aac8dd681001bc490a9b7435b7725798f992f;hpb=eaefb953638f736ee8988251bf8cfc8bedad2563;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index f78aac8..5bfd5bc 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -13,7 +13,7 @@ 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.06000'; +$VERSION = '0.06999_03'; sub MODIFY_CODE_ATTRIBUTES { my ($class,$code,@attrs) = @_; @@ -32,13 +32,13 @@ sub _attr_cache { 1; -=head1 NAME +=head1 NAME DBIx::Class - Extensible and flexible object <-> relational mapper. =head1 SYNOPSIS -Create a base schema class called DB/Main.pm: +Create a schema class called DB/Main.pm: package DB::Main; use base qw/DBIx::Class::Schema/; @@ -47,7 +47,7 @@ Create a base schema class called DB/Main.pm: 1; -Create a class to represent artists, who have many CDs, in 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/; @@ -56,52 +56,56 @@ Create a class to represent artists, who have many CDs, in DB/Main/Artist.pm: __PACKAGE__->table('artist'); __PACKAGE__->add_columns(qw/ artistid name /); __PACKAGE__->set_primary_key('artistid'); - __PACKAGE__->has_many('cds' => 'DB::Main::CD'); + __PACKAGE__->has_many(cds => 'DB::Main::CD'); 1; -A class to represent a CD, which belongs to an artist, in 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__->add_columns(qw/ cdid artist title year /); __PACKAGE__->set_primary_key('cdid'); - __PACKAGE__->belongs_to('artist' => 'DB::Main::Artist'); + __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); + 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 = $ds->resultset('Artist')->all; - my $all_artists_rs = $ds->resultset('Artist'); + my @all_artists = $schema->resultset('Artist')->all; + my $all_artists_rs = $schema->resultset('Artist'); # Create a result set to search for artists. # This does not query the DB. - my $johns_rs = $ds->resultset('Artist')->search( + my $johns_rs = $schema->resultset('Artist')->search( # Build your WHERE using an SQL::Abstract structure: - { 'name' => { 'like', 'John%' } } + { name => { like => 'John%' } } ); - # This executes a joined query to get the cds + # Execute 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. + # 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' } ); - my $millennium_cds_rs = $ds->resultset('CD')->search( + # 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' } ); @@ -109,12 +113,12 @@ Then you can use these classes in your application's code: 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 $millennium_cds_rs->update({ year => 2002 }); # Single-query bulk update @@ -130,27 +134,26 @@ 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). +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 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 +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/ @@ -162,27 +165,8 @@ 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 - -=item L - encapsulates a query and its results - -=item L - row-level methods - -=item L - primary key methods - -=item L - relationships between tables - -=back +L lists each task you might want help on, and +the modules where you will find documentation. =head1 AUTHOR @@ -198,6 +182,8 @@ ank: Andres Kievsky blblack: Brandon Black +bluefeet: Aran Deltac + LTJake: Brian Cassidy claco: Christopher H. Laco @@ -222,6 +208,8 @@ quicksilver: Jules Bean jguenther: Justin Guenther +captainL: Luke Saunders + draven: Marcus Ramberg nigel: Nigel Metheringham @@ -236,10 +224,14 @@ konobi: Scott McWhirter scotty: Scotty Allen +sszabo: Stephan Szabo + Todd Lipcon wdh: Will Hawes +gphat: Cory G Watson + =head1 LICENSE You may distribute this code under the same terms as Perl itself.