X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=7765f9a70e3e74adeba57ef7bbc3ef832f327b4e;hb=fc69fea6a8923cb40755446f1bb914174f53114c;hp=6acc72c01ac6db39da078cc0f49e9d4f8b5ca042;hpb=3942ab4daea039828ef6298129c186349a3003a1;p=dbsrgits%2FDBIx-Class.git

diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm
index 6acc72c..7765f9a 100644
--- a/lib/DBIx/Class.pm
+++ b/lib/DBIx/Class.pm
@@ -4,30 +4,37 @@ use strict;
 use warnings;
 
 use vars qw($VERSION);
-use base qw/DBIx::Class::Componentised/;
+use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
 
-$VERSION = '0.02';
+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.05000';
 
 1;
 
 =head1 NAME 
 
-DBIx::Class - Because the brain is a terrible thing to waste.
+DBIx::Class - Extensible and flexible object <-> relational mapper.
 
 =head1 SYNOPSIS
 
 =head1 DESCRIPTION
 
-This is a sql to oop mapper, inspired by the L<Class::DBI> framework, 
+This is an SQL to OO mapper, inspired by the L<Class::DBI> framework, 
 and meant to support compability with it, while restructuring the 
-insides, and making it possible to support some new features like 
+internals and making it possible to support some new features like 
 self-joins, distinct, group bys and more.
 
-It's currently considered EXPERIMENTAL - bring this near a production
-database at your own risk! The API is *not* fixed yet, although most of
-the primitives should be good for the future and any API changes will be
-posted to the mailing list before they're committed.
+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.
 
 The community can be found via -
 
@@ -41,32 +48,58 @@ The community can be found via -
 
 =head1 QUICKSTART
 
-If you're using Class::DBI, replacing
+If you're using L<Class::DBI>, and want an easy and fast way of migrating to
+DBIx::Class, take a look at L<DBIx::Class::CDBICompat>.
+
+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.
+
+Some examples where different database connections are useful are:
+
+different users with different rights
+different databases with the same schema.
+
+=head2 Simple
+
+First you need to create a base class which all other classes will inherit from.
+See L<DBIx::Class::DB> for information on how to do this.
 
-  use base qw/Class::DBI/;
+Then you need to create a class for every table you want to use with DBIx::Class.
+See L<DBIx::Class::Table> for information on how to do this.
 
-with
+=head2 Schema
 
-  use base qw/DBIx::Class/;
-  __PACKAGE__->load_components(qw/CDBICompat Core DB/);
+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.
 
-will probably get you started.
+Look at L<DBIx::Class::Schema> for information on how to do this.
 
-If you're using AUTO_INCREMENT for your primary columns, you'll also want
-yo load the approriate PK::Auto subclass - e.g.
+If you need more help, check out the introduction in the 
+manual below.
 
-  __PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core DB/);
+=head1 SEE ALSO
 
-(with is what ::Test::SQLite does to present the Class::DBI::Test::SQLite
-interface)
+=head2 L<DBIx::Class::Core> - DBIC Core Classes
 
-If you fancy playing around with DBIx::Class from scratch, then read the docs
-for ::Table and ::Relationship,
+=head2 L<DBIx::Class::Manual> - User's manual
 
-  use base qw/DBIx::Class/;
-  __PACKAGE__->load_components(qw/Core DB/);
+=head2 L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
 
-and have a look at t/lib/DBICTest.pm for a brief example.
+=head2 L<DBIx::Class::DB> - database-level methods
+
+=head2 L<DBIx::Class::Table> - table-level methods
+
+=head2 L<DBIx::Class::Row> - row-level methods
+
+=head2 L<DBIx::Class::PK> - primary key methods
+
+=head2 L<DBIx::Class::ResultSet> - search result-set methods
+
+=head2 L<DBIx::Class::Relationship> - relationships between tables
 
 =head1 AUTHOR
 
@@ -82,10 +115,36 @@ Dan Kubb <dan.kubb-cpan@onautopilot.com>
 
 Dan Sully <daniel@cpan.org>
 
-davekam
+David Kamholz <dkamholz@cpan.org>
+
+Jules Bean
 
 Marcus Ramberg <mramberg@cpan.org>
 
+Paul Makepeace
+
+CL Kao
+
+Jess Robinson
+
+Marcus Ramberg
+
+Will Hawes
+
+Todd Lipcon
+
+Daniel Westermann-Clark <danieltwc@cpan.org>
+
+Alexander Hartmaier <alex_hartmaier@hotmail.com>
+
+Zbigniew Lukasiak
+
+Nigel Metheringham <nigelm@cpan.org>
+
+Jesper Krogh
+
+Brandon Black
+
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.