# $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.08209';
+$VERSION = '0.08270';
$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
-BEGIN {
- package # hide from pause
- DBIx::Class::_ENV_;
-
- use Config;
-
- use constant {
-
- # but of course
- BROKEN_FORK => ($^O eq 'MSWin32') ? 1 : 0,
-
- HAS_ITHREADS => $Config{useithreads} ? 1 : 0,
-
- # ::Runmode would only be loaded by DBICTest, which in turn implies t/
- DBICTEST => eval { DBICTest::RunMode->is_author } ? 1 : 0,
-
- # During 5.13 dev cycle HELEMs started to leak on copy
- PEEPEENESS =>
- # request for all tests would force "non-leaky" illusion and vice-versa
- defined $ENV{DBICTEST_ALL_LEAKS} ? !$ENV{DBICTEST_ALL_LEAKS}
- # otherwise confess that this perl is busted ONLY on smokers
- : eval { DBICTest::RunMode->is_smoker } && ($] >= 5.013005 and $] <= 5.013006) ? 1
- # otherwise we are good
- : 0
- ,
- };
-
- if ($] < 5.009_005) {
- require MRO::Compat;
- constant->import( OLD_MRO => 1 );
- }
- else {
- require mro;
- constant->import( OLD_MRO => 0 );
- }
-}
-
+use DBIx::Class::_Util;
use mro 'c3';
use DBIx::Class::Optional::Dependencies;
1;
+=encoding UTF-8
+
=head1 NAME
DBIx::Class - Extensible and flexible object <-> relational mapper.
+=head1 WHERE TO START READING
+
+See L<DBIx::Class::Manual::DocMap> 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<Manuals|DBIx::Class::Manual::DocMap/Manuals> in the order presented there.
+
+=cut
+
+# *DO NOT* change this heading - it is linked throughout the ecosystem
+
+sub DBIx::Class::_ENV_::HELP_URL () {
+ 'http://p3rl.org/DBIx::Class#GETTING_HELP/SUPPORT'
+}
+
=head1 GETTING HELP/SUPPORT
-The community can be found via:
+Due to the sheer size 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 us via any of the following options (the
+list is sorted by "fastest response time"):
=over
=item * IRC: irc.perl.org#dbix-class
=for html
-<a href="http://chat.mibbit.com/#dbix-class@irc.perl.org">(click for instant chatroom login)</a>
+<a href="https://chat.mibbit.com/#dbix-class@irc.perl.org">(click for instant chatroom login)</a>
=item * Mailing list: L<http://lists.scsys.co.uk/mailman/listinfo/dbix-class>
-=item * Twitter L<http://www.twitter.com/dbix_class>
+=item * RT Bug Tracker: L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=DBIx-Class>
-=item * Web Site: L<http://www.dbix-class.org/>
+=item * Twitter: L<https://www.twitter.com/dbix_class>
-=item * RT Bug Tracker: L<https://rt.cpan.org/Dist/Display.html?Queue=DBIx-Class>
+=item * Web Site: L<http://www.dbix-class.org/>
=back
-The project is maintained in a git repository, accessible from the following sources:
-
-=over
-
-=item * git: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git>
-
-=item * gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git>
-
-=item * github mirror: L<https://github.com/dbsrgits/DBIx-Class>
+=head1 SYNOPSIS
-=item * authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/DBIx-Class.git>
+For the very impatient: L<DBIx::Class::Manual::QuickStart>
-=item * Travis-CI log: L<http://travis-ci.org/dbsrgits/dbix-class/builds>
+This code in the next step can be generated automatically from an existing
+database, see L<dbicdump> from the distribution C<DBIx-Class-Schema-Loader>.
-=for html
-<img src="https://secure.travis-ci.org/dbsrgits/dbix-class.png?branch=master"></img>
+=head2 Schema classes preparation
-=back
-
-=head1 SYNOPSIS
-
-Create a schema class called MyApp/Schema.pm:
+Create a schema class called F<MyApp/Schema.pm>:
package MyApp::Schema;
use base qw/DBIx::Class::Schema/;
1;
Create a result class to represent artists, who have many CDs, in
-MyApp/Schema/Result/Artist.pm:
+F<MyApp/Schema/Result/Artist.pm>:
See L<DBIx::Class::ResultSource> 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<MyApp/Schema/Result/CD.pm>:
package MyApp::Schema::Result::CD;
use base qw/DBIx::Class::Core/;
1;
+=head2 API usage
+
Then you can use these classes in your application's code:
# Connect to your database.
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<JOIN>, C<LEFT JOIN>, C<COUNT>, C<DISTINCT>, C<GROUP BY>, C<ORDER BY> and
+C<HAVING> 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
L<your DBD may not be|DBI/Threads and Thread Safety>).
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<experimental> - such APIs are still usable but may have edge bugs.
+Failing test cases are I<always> 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
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
+
+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 ;)
-L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
-the modules where you will find documentation.
+This project is maintained in a git repository. The code and related tools are
+accessible at the following locations:
+
+=over
+
+=item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git>
+
+=item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git>
+
+=item * GitHub mirror: L<https://github.com/dbsrgits/DBIx-Class>
+
+=item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/DBIx-Class.git>
+
+=item * Travis-CI log: L<https://travis-ci.org/dbsrgits/dbix-class/builds>
+
+=for html
+↪ Stable branch CI status: <img src="https://secure.travis-ci.org/dbsrgits/dbix-class.png?branch=master"></img>
+
+=back
=head1 AUTHOR
amoore: Andrew Moore <amoore@cpan.org>
+Andrew Mehta <Andrew@unitedgames.co.uk>
+
andrewalker: Andre Walker <andre@andrewalker.net>
andyg: Andy Grundman <andy@hybridized.org>
ash: Ash Berlin <ash@cpan.org>
-bert: Norbert Csongradi <bert@cpan.org>
+bert: Norbert Csongrádi <bert@cpan.org>
+
+bfwg: Colin Newell <colin.newell@gmail.com>
blblack: Brandon L. Black <blblack@gmail.com>
clkao: CL Kao
+Ctrl-o L<http://ctrlo.com/>
+
da5id: David Jack Olrik <djo@cpan.org>
+dariusj: Darius Jokilehto <dariusjokilehto@yahoo.co.uk>
+
davewood: David Schmidt <davewood@gmx.at>
+daxim: Lars Dɪᴇᴄᴋᴏᴡ 迪拉斯 <daxim@cpan.org>
+
debolaz: Anders Nor Berle <berle@cpan.org>
dew: Dan Thomas <dan@godders.org>
+dim0xff: Dmitry Latin <dim0xff@gmail.com>
+
dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
dnm: Justin Wheeler <jwheeler@datademons.com>
dpetrov: Dimitar Petrov <mitakaa@gmail.com>
+duncan_dmg: Duncan Garland <Duncan.Garland@motortrak.com>
+
dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
edenc: Eden Cardim <edencardim@gmail.com>
+Eligo L<http://eligo.co.uk/>
+
+ether: Karen Etheridge <ether@cpan.org>
+
felliott: Fitz Elliott <fitz.elliott@gmail.com>
freetime: Bill Moseley <moseley@hank.org>
hobbs: Andrew Rodland <arodland@cpan.org>
+idn: Ian Norton <i.norton@shadowcat.co.uk>
+
ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
initself: Mike Baas <mike@initselftech.com>
mattp: Matt Phillips <mattp@cpan.org>
+mdk: Mark Keating <m.keating@shadowcat.co.uk>
+
+mna: Maya
+
michaelr: Michael Reddick <michael.reddick@gmail.com>
milki: Jonathan Chu <milki@rescomp.berkeley.edu>
+minty: Murray Walker <perl@minty.org>
+
+mithaldu: Christian Walde <walde.christian@gmail.com>
+
mjemmeson: Michael Jemmeson <michael.jemmeson@gmail.com>
+mrf: Mike Francis <ungrim97@gmail.com>
+
mstratman: Mark A. Stratman <stratman@gmail.com>
ned: Neil de Carteret
peter: Peter Collingbourne <peter@pcc.me.uk>
+Peter Siklósi <einon@einon.hu>
+
Peter Valdemar ME<oslash>rch <peter@morch.com>
phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
plu: Johannes Plunien <plu@cpan.org>
+pplu: Jose Luis Martinez <jlmartinez@capside.com>
+
Possum: Daniel LeWarne <possum@cpan.org>
quicksilver: Jules Bean
SineSwiper: Brendan Byrd <bbyrd@cpan.org>
+skaufman: Samuel Kaufman <sam@socialflow.com>
+
solomon: Jared Johnson <jaredj@nmgi.com>
spb: Stephen Bennett <stephen@freenode.net>
sszabo: Stephan Szabo <sszabo@bigpanda.com>
+Stephen Peters <steve@stephenpeters.me>
+
talexb: Alex Beamish <talexb@gmail.com>
tamias: Ronald J Kimball <rjk@tamias.net>
+TBSliver: Tom Bloor <t.bloor@shadowcat.co.uk>
+
teejay : Aaron Trevena <teejay@cpan.org>
+theorbtwo: James Mastros <james@mastros.biz>
+
Todd Lipcon
Tom Hukins
xenoterracide: Caleb Cushing <xenoterracide@gmail.com>
+uree: Oriol Soriano <oriol.soriano@capside.com>
+
yrlnry: Mark Jason Dominus <mjd@plover.com>
zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
+Zefram: Andrew Main <zefram@fysh.org>
+
=head1 COPYRIGHT
Copyright (c) 2005 - 2011 the DBIx::Class L</AUTHOR> and L</CONTRIBUTORS>
This library is free software and may be distributed under the same terms
as perl itself.
-
-=cut
projects / dbsrgits/DBIx-Class.git / blobdiff