X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=ab9c53a4f8d3d94a31a04e77f1577c6e14724380;hb=49995cc8a37e1628fd93f52c58f3d9e2e34341d2;hp=db6eda095904bd4ca6636f790cab169696d816f7;hpb=503536d5b216b4d85ed3f5420f3db93d4c033d86;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index db6eda0..ab9c53a 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -4,30 +4,32 @@ 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.03'; +sub mk_classdata { shift->mk_classaccessor(@_); } +$VERSION = '0.04999_02'; 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 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. -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 +43,58 @@ The community can be found via - =head1 QUICKSTART -If you're using Class::DBI, replacing +If you're using L, and want an easy and fast way of migrating to +DBIx::Class, take a look at L. - use base qw/Class::DBI/; +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. -with +Some examples where different database connections are useful are: - use base qw/DBIx::Class/; - __PACKAGE__->load_components(qw/CDBICompat Core DB/); +different users with different rights +different databases with the same schema. -will probably get you started. +=head2 Simple -If you're using AUTO_INCREMENT for your primary columns, you'll also want -yo load the approriate PK::Auto subclass - e.g. +First you need to create a base class which all other classes will inherit from. +See L for information on how to do this. - __PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core DB/); +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. -(with is what ::Test::SQLite does to present the Class::DBI::Test::SQLite -interface) +=head2 Schema -If you fancy playing around with DBIx::Class from scratch, then read the docs -for DBIx::Class::Table, ::Row, ::Schema, ::DB and ::Relationship, +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. - use base qw/DBIx::Class/; - __PACKAGE__->load_components(qw/Core DB/); +Look at L for information on how to do this. -and have a look at t/lib/DBICTest.pm for a brief example. +If you need more help, check out the introduction in the +manual below. + +=head1 SEE ALSO + +=head2 L - DBIC Core Classes + +=head2 L - User's manual + +=head2 L - L Compat layer + +=head2 L - database-level methods + +=head2 L - table-level methods + +=head2 L - row-level methods + +=head2 L - primary key methods + +=head2 L - search result-set methods + +=head2 L - relationships between tables =head1 AUTHOR @@ -82,10 +110,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.