X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=c2108e43ebfe769b21303bf6b7eee5305c597f6c;hb=7a1fe534b4b49dab3a7585dbbf246ac0f43e42d1;hp=4dcaf62640ec636659992c8ae093c290cbdce238;hpb=773e30151b762903af9584a7943093170fdae91c;p=dbsrgits%2FDBIx-Class.git diff --git a/README b/README index 4dcaf62..c2108e4 100644 --- a/README +++ b/README @@ -3,17 +3,17 @@ NAME SYNOPSIS DESCRIPTION - This is a sql to oop mapper, inspired by the Class::DBI framework, and - meant to support compability with it, while restructuring the insides, + This is an SQL to OO mapper, inspired by the Class::DBI framework, and + meant to support compability with it, while restructuring the 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 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. + 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 - @@ -27,47 +27,46 @@ DESCRIPTION QUICKSTART If you're using Class::DBI, and want an easy and fast way of migrating - to DBIx::Class look at DBIx::Class::CDBICompat. + to DBIx::Class, take a look at DBIx::Class::CDBICompat. - There are two ways of using DBIx::Class, the 'simple' and the 'schema' - one. - - 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. -Simple - First you need to create a base class all other classes inherit from. - - Look at DBIx::Class::DB how to do this - - Next you need to create a class for every table you want to use with - DBIx::Class. + Simple + First you need to create a base class which all other classes will + inherit from. See DBIx::Class::DB for information on how to do this. - Look at DBIx::Class::Table how to do this. + Then you need to create a class for every table you want to use with + DBIx::Class. See DBIx::Class::Table for information on how to do this. 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 + 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, loading auto primary key support. + config file or loading auto primary key support. - Look at DBIx::Class::Schema how to do this. + Look at DBIx::Class::Schema for information on how to do this. - If you need more hand-holding, check out the introduction in the manual - below. + If you need more help, check out the introduction in the manual below. SEE ALSO - DBIx::Class::Core - DBIC Core Classes - DBIx::Class::CDBICompat - Class::DBI Compat layer. - DBIx::Class::Manual - User's manual. - + DBIx::Class::Core - DBIC Core Classes + DBIx::Class::Manual - User's manual + DBIx::Class::CDBICompat - Class::DBI Compat layer + DBIx::Class::DB - database-level methods + DBIx::Class::Table - table-level methods + DBIx::Class::Row - row-level methods + DBIx::Class::PK - primary key methods + DBIx::Class::ResultSet - search result-set methods + DBIx::Class::Relationship - relationships between tables AUTHOR Matt S. Trout @@ -80,10 +79,36 @@ CONTRIBUTORS Dan Sully - davekam + David Kamholz + + Jules Bean Marcus Ramberg + Paul Makepeace + + CL Kao + + Jess Robinson + + Marcus Ramberg + + Will Hawes + + Todd Lipcon + + Daniel Westermann-Clark + + Alexander Hartmaier + + Zbigniew Lukasiak + + Nigel Metheringham + + Jesper Krogh + + Brandon Black + LICENSE You may distribute this code under the same terms as Perl itself.