version bump, deprecated ResultSetManager
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class.pm
index 1812b4d..98dc34a 100644 (file)
@@ -4,35 +4,48 @@ use strict;
 use warnings;
 
 use vars qw($VERSION);
-use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
+use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/;
+use DBIx::Class::StartupCheck;
+
+
+sub mk_classdata { 
+  shift->mk_classaccessor(@_);
+}
+
+sub mk_classaccessor {
+  my $self = shift;
+  $self->mk_group_accessors('inherited', $_[0]); 
+  $self->set_inherited(@_) if @_ > 1;
+}
 
-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.06000';
+$VERSION = '0.08099_01';
+
+$VERSION = eval $VERSION; # numify for warning-free dev releases
 
 sub MODIFY_CODE_ATTRIBUTES {
-    my ($class,$code,@attrs) = @_;
-    $class->mk_classdata('__attr_cache' => {})
-      unless $class->can('__attr_cache');
-    $class->__attr_cache->{$code} = [@attrs];
-    return ();
+  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 };
+  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.
 
@@ -87,7 +100,7 @@ Then you can use these classes in your application's code:
   # 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 L<SQL::Abstract> structure:
+    # Build your WHERE using an SQL::Abstract structure:
     { name => { like => 'John%' } }
   );
 
@@ -105,7 +118,7 @@ Then you can use these classes in your application's code:
 
   # 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 = $ds->resultset('CD')->search(
+  my $millennium_cds_rs = $schema->resultset('CD')->search(
     { year => 2000 },
     { prefetch => 'artist' }
   );
@@ -113,12 +126,14 @@ 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' });
+  # new() makes a DBIx::Class::Row object but doesnt insert it into the DB.
+  # create() is the same as new() then insert().
+  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
 
@@ -134,118 +149,155 @@ 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 
+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). 
+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.
+This project is still under rapid development, so large new features may be
+marked EXPERIMENTAL - such APIs are still usable but may have edge bugs.
+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.
+We do our best to maintain full backwards compatibility for published
+APIs, since DBIx::Class is used in production in many organisations,
+and even backwards incompatible changes to non-published APIs will be fixed
+if they're reported and doing so doesn't cost the codebase anything.
+
+The test suite is quite substantial, and several developer releases
+are generally made to CPAN before the branch for the next release 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/
+  Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/
 
-  SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
+  SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/
 
-  Wiki: http://dbix-class.shadowcatsystems.co.uk/
+  SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/
 
   IRC: irc.perl.org#dbix-class
 
 =head1 WHERE TO GO NEXT
 
-=over 4
-
-=item L<DBIx::Class::Manual> - user's manual
-
-=item L<DBIx::Class::Core> - DBIC Core Classes
-
-=item L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
-
-=item L<DBIx::Class::Schema> - schema and connection container
-
-=item L<DBIx::Class::ResultSource> - tables and table-like things
-
-=item L<DBIx::Class::ResultSet> - encapsulates a query and its results
-
-=item L<DBIx::Class::Row> - row-level methods
-
-=item L<DBIx::Class::PK> - primary key methods
-
-=item L<DBIx::Class::Relationship> - relationships between tables
-
-=back
+L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
+the modules where you will find documentation.
 
 =head1 AUTHOR
 
 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
 
+(I mostly consider myself "project founder" these days but the AUTHOR heading
+is traditional :)
+
 =head1 CONTRIBUTORS
 
 abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
 
+aherzog: Adam Herzog <adam@herzogdesigns.com>
+
 andyg: Andy Grundman <andy@hybridized.org>
 
 ank: Andres Kievsky
 
-blblack: Brandon Black
+ash: Ash Berlin <ash@cpan.org>
 
-LTJake: Brian Cassidy <bricas@cpan.org>
+bert: Norbert Csongradi <bert@cpan.org>
+
+blblack: Brandon L. Black <blblack@gmail.com>
+
+bluefeet: Aran Deltac <bluefeet@cpan.org>
+
+captainL: Luke Saunders <luke.saunders@gmail.com>
+
+castaway: Jess Robinson
 
 claco: Christopher H. Laco
 
 clkao: CL Kao
 
-typester: Daisuke Murase <typester@cpan.org>
+da5id: David Jack Olrik <djo@cpan.org>
+
+debolaz: Anders Nor Berle <berle@cpan.org>
 
 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
 
-Numa: Dan Sully <daniel@cpan.org>
+dnm: Justin Wheeler <jwheeler@datademons.com>
+
+draven: Marcus Ramberg <mramberg@cpan.org>
 
 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
 
-ningu: David Kamholz <dkamholz@cpan.org>
+dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
+
+gphat: Cory G Watson <gphat@cpan.org>
 
 jesper: Jesper Krogh
 
-castaway: Jess Robinson
+jguenther: Justin Guenther <jguenther@cpan.org>
 
-quicksilver: Jules Bean
+jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
 
-jguenther: Justin Guenther <guentherj@agr.gc.ca>
+jon: Jon Schutz <jjschutz@cpan.org>
 
-draven: Marcus Ramberg <mramberg@cpan.org>
+jshirley: J. Shirley <jshirley@gmail.com>
+
+konobi: Scott McWhirter
+
+LTJake: Brian Cassidy <bricas@cpan.org>
+
+mattlaw: Matt Lawrence
+
+ned: Neil de Carteret
 
 nigel: Nigel Metheringham <nigelm@cpan.org>
 
+ningu: David Kamholz <dkamholz@cpan.org>
+
+Numa: Dan Sully <daniel@cpan.org>
+
+oyse: Ã˜ystein Torget <oystein.torget@dnv.com>
+
 paulm: Paul Makepeace
 
+penguin: K J Cheetham
+
+perigrin: Chris Prather <chris@prather.org>
+
 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
 
-sc_: Just Another Perl Hacker
+quicksilver: Jules Bean
 
-konobi: Scott McWhirter
+rdj: Ryan D Johnson <ryan@innerfence.com>
+
+sc_: Just Another Perl Hacker
 
 scotty: Scotty Allen <scotty@scottyallen.com>
 
+semifor: Marc Mims <marc@questright.com>
+
+sszabo: Stephan Szabo <sszabo@bigpanda.com>
+
+teejay : Aaron Trevena <teejay@cpan.org>
+
 Todd Lipcon
 
+Tom Hukins
+
+typester: Daisuke Murase <typester@cpan.org>
+
+victori: Victor Igumnov <victori@cpan.org>
+
 wdh: Will Hawes
 
+willert: Sebastian Willert <willert@cpan.org>
+
+zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
+
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-