X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=e7b505b35940474ac74aa703604b69eb3a8747a7;hb=c36f8d8d60e965f3409e8f77dda9a7eab6621540;hp=66fc8a3c5b1e1de79b392635b382f09e41c724dd;hpb=08d7807b3b84a2cee06f267083dd317d28148bd0;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 66fc8a3..e7b505b 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -11,7 +11,7 @@ our $VERSION; # $VERSION declaration must stay up here, ahead of any other package # declarations, as to not confuse various modules attempting to determine # this ones version, whether that be s.c.o. or Module::Metadata, etc -$VERSION = '0.08206'; +$VERSION = '0.08250'; $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases @@ -95,53 +95,51 @@ sub _attr_cache { 1; +__END__ + +=encoding UTF-8 + =head1 NAME DBIx::Class - Extensible and flexible object <-> relational mapper. -=head1 GETTING HELP/SUPPORT +=head1 WHERE TO START READING + +See L for an overview of the exhaustive documentation. +To get the most out of DBIx::Class with the least confusion it is strongly +recommended to read (at the very least) the +L in the order presented there. -The community can be found via: +=head1 HOW TO GET HELP + +Due to the complexity of its problem domain, DBIx::Class is a relatively +complex framework. After you start using DBIx::Class questions will inevitably +arise. If you are stuck with a problem or have doubts about a particular +approach do not hesitate to contact the community with your questions. The +list below is sorted by "fastest response time": =over =item * IRC: irc.perl.org#dbix-class =for html -(click for instant chatroom login) +(click for instant chatroom login) =item * Mailing list: L -=item * Twitter L - -=item * Web Site: L - -=item * RT Bug Tracker: L - -=back - -The project is maintained in a git repository, accessible from the following sources: +=item * RT Bug Tracker: L -=over - -=item * git: L - -=item * gitweb: L - -=item * github mirror: L - -=item * authorized committers: L +=item * Twitter: L -=item * Travis-CI log: L - -=for html - +=item * Web Site: L =back =head1 SYNOPSIS -Create a schema class called MyApp/Schema.pm: +=head2 Schema classes preparation + +Create a schema class called F: package MyApp::Schema; use base qw/DBIx::Class::Schema/; @@ -151,7 +149,7 @@ Create a schema class called MyApp/Schema.pm: 1; Create a result class to represent artists, who have many CDs, in -MyApp/Schema/Result/Artist.pm: +F: See L for docs on defining result classes. @@ -166,7 +164,7 @@ See L for docs on defining result classes. 1; A result class to represent a CD, which belongs to an artist, in -MyApp/Schema/Result/CD.pm: +F: package MyApp::Schema::Result::CD; use base qw/DBIx::Class::Core/; @@ -179,6 +177,8 @@ MyApp/Schema/Result/CD.pm: 1; +=head2 API usage + Then you can use these classes in your application's code: # Connect to your database. @@ -247,7 +247,8 @@ that allows abstract encapsulation of database operations. It aims to make representing queries in your code as perl-ish as possible while still providing access to as many of the capabilities of the database as possible, including retrieving related records from multiple tables in a single query, -JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and HAVING support. +C, C, C, C, C, C and +C 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 @@ -260,8 +261,8 @@ and thread-safe out of the box (although L). 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 +marked B - such APIs are still usable but may have edge bugs. +Failing test cases are I welcome and point releases are put out rapidly as bugs are found and fixed. We do our best to maintain full backwards compatibility for published @@ -273,10 +274,37 @@ 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. -=head1 WHERE TO GO NEXT +=head1 HOW TO CONTRIBUTE -L lists each task you might want help on, and -the modules where you will find documentation. +Contributions are always welcome, in all usable forms (we especially +welcome documentation improvements). The delivery methods include git- +or unified-diff formatted patches, GitHub pull requests, or plain bug +reports either via RT or the Mailing list. Contributors are generally +granted full access to the official repository after their first patch +passes successful review. + +=for comment +FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;) + +This project is maintained in a git repository. The code and related tools are +accessible at the following locations: + +=over + +=item * Official repo: L + +=item * Official gitweb: L + +=item * GitHub mirror: L + +=item * Authorized committers: L + +=item * Travis-CI log: L + +=for html +↪ Stable branch CI status: + +=back =head1 AUTHOR @@ -303,6 +331,8 @@ amiri: Amiri Barksdale amoore: Andrew Moore +andrewalker: Andre Walker + andyg: Andy Grundman ank: Andres Kievsky @@ -341,6 +371,12 @@ clkao: CL Kao da5id: David Jack Olrik +dariusj: Darius Jokilehto + +davewood: David Schmidt + +daxim: Lars Dɪᴇᴄᴋᴏᴡ 迪拉斯 + debolaz: Anders Nor Berle dew: Dan Thomas @@ -419,6 +455,8 @@ michaelr: Michael Reddick milki: Jonathan Chu +mithaldu: Christian Walde + mjemmeson: Michael Jemmeson mstratman: Mark A. Stratman @@ -538,5 +576,3 @@ as listed above. This library is free software and may be distributed under the same terms as perl itself. - -=cut