X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=9f02215dad80a438f82c02a036cc5a39ba0dc039;hb=e430cbebb14df385e2a94848714e94d9521c179c;hp=744cb4a0a03ae79742430cfa70e88e09450a6bf4;hpb=47bd0267e91b5dbaea2cdbc9c28ec661c06849c8;p=dbsrgits%2FDBIx-Class-Historic.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 744cb4a..9f02215 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -8,7 +8,6 @@ use base qw/DBIx::Class::Componentised Class::Data::Inheritable/; $VERSION = '0.04001'; - 1; =head1 NAME @@ -19,14 +18,14 @@ DBIx::Class - Extensible and flexible object <-> relational mapper. =head1 DESCRIPTION -This is a sql to oop mapper, inspired by the L framework, +This is an SQL to OO 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 +internals and making it possible to support some new features like self-joins, distinct, group bys and more. -This project is still at an early stage so the maintainers don't make +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 +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. @@ -42,55 +41,58 @@ The community can be found via - =head1 QUICKSTART -If you're using Class::DBI, and want an easy and fast way of migrating to -DBIx::Class look at L. - -There are two ways of using DBIx::Class, the 'simple' and the 'schema' one. +If you're using L, and want an easy and fast way of migrating to +DBIx::Class, take a look at L. -The 'simple' way of using DBIx::Class needs less classes than the 'schema' -way but doesn't give you the ability to use different database connections. +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. -=head1 Simple - -First you need to create a base class all other classes inherit from. +=head2 Simple -Look at L how to do this - -Next you need to create a class for every table you want to use with -DBIx::Class. - -Look at L how to do this. +First you need to create a base class which all other classes will inherit from. +See L for information on how to do this. +Then you need to create a class for every table you want to use with DBIx::Class. +See L for information on how to do this. =head2 Schema -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 which inherits from DBIx::Class::Core and adds additional methods -needed by all table classes, e.g. reading a config file, loading auto primary +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. -Look at L how to do this. +Look at L for information on how to do this. -If you need more hand-holding, check out the introduction in the +If you need more help, check out the introduction in the manual below. =head1 SEE ALSO -=over 4 +=head2 L - DBIC Core Classes + +=head2 L - User's manual -=item L - DBIC Core Classes +=head2 L - L Compat layer -=item L - L Compat layer. +=head2 L - database-level methods -=item L - User's manual. +=head2 L - table-level methods -=back +=head2 L - row-level methods + +=head2 L - primary key methods + +=head2 L - search result-set methods + +=head2 L - relationships between tables =head1 AUTHOR @@ -106,10 +108,14 @@ Dan Kubb Dan Sully -davekam +David Kamholz + +Jules Bean Marcus Ramberg +Paul Makepeace + =head1 LICENSE You may distribute this code under the same terms as Perl itself.