package DBIx::Class;
+# important to load early
+use DBIx::Class::_Util;
+
use strict;
use warnings;
-use vars qw($VERSION);
-use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/;
-use DBIx::Class::StartupCheck;
-
-
-sub mk_classdata {
- shift->mk_classaccessor(@_);
-}
-
-sub mk_classaccessor {
- my $self = shift;
- $self->mk_group_accessors('inherited', $_[0]);
- $self->set_inherited(@_) if @_ > 1;
-}
-
-sub component_base_class { 'DBIx::Class' }
-
+our $VERSION;
# Always remember to do all digits for the version even if they're 0
# i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
# brain damage and presumably various other packaging systems too
-$VERSION = '0.08099_01';
+# $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.082899_25';
-$VERSION = eval $VERSION; # numify for warning-free dev releases
+$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
-sub MODIFY_CODE_ATTRIBUTES {
- my ($class,$code,@attrs) = @_;
- $class->mk_classdata('__attr_cache' => {})
- unless $class->can('__attr_cache');
- $class->__attr_cache->{$code} = [@attrs];
- return ();
-}
+use mro 'c3';
+
+use base qw/DBIx::Class::Componentised DBIx::Class::AccessorGroup/;
+
+__PACKAGE__->mk_classaccessor(
+ _skip_namespace_frames => join( '|', map { '^' . $_ } qw(
+ DBIx::Class
+ SQL::Abstract
+ SQL::Translator
+ Try::Tiny
+ Class::Accessor::Grouped
+ Context::Preserve
+ Moose::Meta::
+ )),
+);
-sub _attr_cache {
- my $self = shift;
- my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {};
- my $rest = eval { $self->next::method };
- return $@ ? $cache : { %$cache, %$rest };
+sub component_base_class { 'DBIx::Class' }
+
+# *DO NOT* change this URL nor the identically named =head1 below
+# it is linked throughout the ecosystem
+sub DBIx::Class::_ENV_::HELP_URL () {
+ 'http://p3rl.org/DBIx::Class#GETTING_HELP/SUPPORT'
}
1;
+__END__
+
=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
+
=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
- Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/
+=item * IRC: irc.perl.org#dbix-class
- SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/
+=for html
+<a href="https://chat.mibbit.com/#dbix-class@irc.perl.org">(click for instant chatroom login)</a>
- SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/
+=item * Mailing list: L<http://lists.scsys.co.uk/mailman/listinfo/dbix-class>
- IRC: irc.perl.org#dbix-class
+=item * RT Bug Tracker: L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=DBIx-Class>
+
+=item * Twitter: L<https://www.twitter.com/dbix_class>
+
+=item * Web Site: L<http://www.dbix-class.org/>
+
+=back
=head1 SYNOPSIS
-Create a schema class called DB/Main.pm:
+For the very impatient: L<DBIx::Class::Manual::QuickStart>
+
+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>.
- package DB::Main;
+=head2 Schema classes preparation
+
+Create a schema class called F<MyApp/Schema.pm>:
+
+ package MyApp::Schema;
use base qw/DBIx::Class::Schema/;
- __PACKAGE__->load_classes();
+ __PACKAGE__->load_namespaces();
1;
-Create a table class to represent artists, who have many CDs, in DB/Main/Artist.pm:
+Create a result class to represent artists, who have many CDs, in
+F<MyApp/Schema/Result/Artist.pm>:
- package DB::Main::Artist;
- use base qw/DBIx::Class/;
+See L<DBIx::Class::ResultSource> for docs on defining result classes.
+
+ package MyApp::Schema::Result::Artist;
+ use base qw/DBIx::Class::Core/;
- __PACKAGE__->load_components(qw/PK::Auto Core/);
__PACKAGE__->table('artist');
__PACKAGE__->add_columns(qw/ artistid name /);
__PACKAGE__->set_primary_key('artistid');
- __PACKAGE__->has_many(cds => 'DB::Main::CD');
+ __PACKAGE__->has_many(cds => 'MyApp::Schema::Result::CD', 'artistid');
1;
-A table class to represent a CD, which belongs to an artist, in DB/Main/CD.pm:
+A result class to represent a CD, which belongs to an artist, in
+F<MyApp/Schema/Result/CD.pm>:
- package DB::Main::CD;
- use base qw/DBIx::Class/;
+ package MyApp::Schema::Result::CD;
+ use base qw/DBIx::Class::Core/;
- __PACKAGE__->load_components(qw/PK::Auto Core/);
+ __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
__PACKAGE__->table('cd');
- __PACKAGE__->add_columns(qw/ cdid artist title year /);
+ __PACKAGE__->add_columns(qw/ cdid artistid title year /);
__PACKAGE__->set_primary_key('cdid');
- __PACKAGE__->belongs_to(artist => 'DB::Main::Artist');
+ __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Result::Artist', 'artistid');
1;
+=head2 API usage
+
Then you can use these classes in your application's code:
# Connect to your database.
- use DB::Main;
- my $schema = DB::Main->connect($dbi_dsn, $user, $pass, \%dbi_params);
+ use MyApp::Schema;
+ my $schema = MyApp::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params);
# Query for all artists and put them in an array,
# or retrieve them as a result set object.
+ # $schema->resultset returns a DBIx::Class::ResultSet
my @all_artists = $schema->resultset('Artist')->all;
my $all_artists_rs = $schema->resultset('Artist');
+ # Output all artists names
+ # $artist here is a DBIx::Class::Row, which has accessors
+ # for all its columns. Rows are also subclasses of your Result class.
+ foreach $artist (@all_artists) {
+ print $artist->name, "\n";
+ }
+
# Create a result set to search for artists.
# This does not query the DB.
my $johns_rs = $schema->resultset('Artist')->search(
# Execute a joined query to get the cds.
my @all_john_cds = $johns_rs->search_related('cds')->all;
- # Fetch only the next row.
+ # Fetch the next available row.
my $first_john = $johns_rs->next;
# Specify ORDER BY on the query.
{ order_by => 'title' }
);
- # Create a result set that will fetch the artist relationship
+ # Create a result set that will fetch the artist data
# at the same time as it fetches CDs, using only one query.
my $millennium_cds_rs = $schema->resultset('CD')->search(
{ year => 2000 },
);
my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
- my $cd_artist_name = $cd->artist->name; # Already has the data so no query
+ my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query
- # new() makes a DBIx::Class::Row object but doesnt insert it into the DB.
+ # new() makes a Result object but doesn't insert it into the DB.
# create() is the same as new() then insert().
my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
$new_cd->artist($cd->artist);
$schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
- $millennium_cds_rs->update({ year => 2002 }); # Single-query bulk update
+ # change the year of all the millennium CDs at once
+ $millennium_cds_rs->update({ year => 2002 });
=head1 DESCRIPTION
This is an SQL to OO mapper with an object API inspired by L<Class::DBI>
-(and a compatibility layer as a springboard for porting) and a resultset API
+(with a compatibility layer as a springboard for porting) and a resultset API
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 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
handle as requested in order to minimise memory usage. It has auto-increment
support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is
known to be used in production on at least the first four, and is fork-
-and thread-safe out of the box (although your DBD may not be).
+and thread-safe out of the box (although
+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
-
-L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
-the modules where you will find documentation.
-
-=head1 AUTHOR
-
-mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
+=head1 HOW TO CONTRIBUTE
-(I mostly consider myself "project founder" these days but the AUTHOR heading
-is traditional :)
+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 access to the official repository after their first several
+patches pass successful review. Don't hesitate to
+L<contact|/GETTING HELP/SUPPORT> either of the L</CAT HERDERS> with
+any further questions you may have.
-=head1 CONTRIBUTORS
+=for comment
+FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;)
-abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
+This project is maintained in a git repository. The code and related tools are
+accessible at the following locations:
-aherzog: Adam Herzog <adam@herzogdesigns.com>
+=over
-andyg: Andy Grundman <andy@hybridized.org>
+=item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git>
-ank: Andres Kievsky
+=item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git>
-ash: Ash Berlin <ash@cpan.org>
+=item * GitHub mirror: L<https://github.com/dbsrgits/DBIx-Class>
-bert: Norbert Csongradi <bert@cpan.org>
+=item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/DBIx-Class.git>
-blblack: Brandon L. Black <blblack@gmail.com>
+=item * Travis-CI log: L<https://travis-ci.org/dbsrgits/dbix-class/builds>
-bluefeet: Aran Deltac <bluefeet@cpan.org>
+=for html
+↪ Bleeding edge dev CI status: <img src="https://secure.travis-ci.org/dbsrgits/dbix-class.png?branch=master"></img>
-captainL: Luke Saunders <luke.saunders@gmail.com>
+=back
-castaway: Jess Robinson
+=head1 AUTHORS
-claco: Christopher H. Laco
+Even though a large portion of the source I<appears> to be written by just a
+handful of people, this library continues to remain a collaborative effort -
+perhaps one of the most successful such projects on L<CPAN|http://cpan.org>.
+It is important to remember that ideas do not always result in a direct code
+contribution, but deserve acknowledgement just the same. Time and time again
+the seemingly most insignificant questions and suggestions have been shown
+to catalyze monumental improvements in consistency, accuracy and performance.
-clkao: CL Kao
+=for comment this line is replaced with the author list at dist-building time
-da5id: David Jack Olrik <djo@cpan.org>
+The canonical source of authors and their details is the F<AUTHORS> file at
+the root of this distribution (or repository). The canonical source of
+per-line authorship is the L<git repository|/HOW TO CONTRIBUTE> history
+itself.
-debolaz: Anders Nor Berle <berle@cpan.org>
+=head1 CAT HERDERS
-dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
+The fine folks nudging the project in a particular direction:
-dnm: Justin Wheeler <jwheeler@datademons.com>
+=over
-draven: Marcus Ramberg <mramberg@cpan.org>
+B<ribasushi>: Peter Rabbitson <ribasushi@cpan.org>
+(present day maintenance and controlled evolution)
-dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
+B<castaway>: Jess Robinson <castaway@desert-island.me.uk>
+(lions share of the reference documentation and manuals)
-dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
+B<mst>: Matt S Trout <mst@shadowcat.co.uk> (project founder -
+original idea, architecture and implementation)
-gphat: Cory G Watson <gphat@cpan.org>
+=back
-jesper: Jesper Krogh
+=head1 COPYRIGHT AND LICENSE
-jguenther: Justin Guenther <jguenther@cpan.org>
+Copyright (c) 2005 by mst, castaway, ribasushi, and other DBIx::Class
+L</AUTHORS> as listed above and in F<AUTHORS>.
-jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
-
-jon: Jon Schutz <jjschutz@cpan.org>
-
-jshirley: J. Shirley <jshirley@gmail.com>
-
-konobi: Scott McWhirter
-
-LTJake: Brian Cassidy <bricas@cpan.org>
-
-mattlaw: Matt Lawrence
-
-ned: Neil de Carteret
-
-nigel: Nigel Metheringham <nigelm@cpan.org>
-
-ningu: David Kamholz <dkamholz@cpan.org>
-
-Numa: Dan Sully <daniel@cpan.org>
-
-oyse: Øystein Torget <oystein.torget@dnv.com>
-
-paulm: Paul Makepeace
-
-penguin: K J Cheetham
-
-perigrin: Chris Prather <chris@prather.org>
-
-phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
-
-quicksilver: Jules Bean
-
-rdj: Ryan D Johnson <ryan@innerfence.com>
-
-sc_: Just Another Perl Hacker
-
-scotty: Scotty Allen <scotty@scottyallen.com>
-
-semifor: Marc Mims <marc@questright.com>
-
-sszabo: Stephan Szabo <sszabo@bigpanda.com>
-
-teejay : Aaron Trevena <teejay@cpan.org>
-
-Todd Lipcon
-
-Tom Hukins
-
-typester: Daisuke Murase <typester@cpan.org>
-
-victori: Victor Igumnov <victori@cpan.org>
-
-wdh: Will Hawes
-
-willert: Sebastian Willert <willert@cpan.org>
-
-zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
-
-=head1 LICENSE
-
-You may distribute this code under the same terms as Perl itself.
-
-=cut
+This library is free software and may be distributed under the same terms
+as perl5 itself. See F<LICENSE> for the complete licensing terms.