use strict;
use warnings;
+use MRO::Compat;
+
use vars qw($VERSION);
-use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
+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 mk_classdata { shift->mk_classaccessor(@_); }
sub component_base_class { 'DBIx::Class' }
# 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.05999_04';
+$VERSION = '0.08111';
+
+$VERSION = eval $VERSION; # numify for warning-free dev releases
+
+# what version of sqlt do we require if deploy() without a ddl_dir is invoked
+# when changing also adjust $sqlt_recommends in Makefile.PL
+my $minimum_sqlt_version = '0.11002';
sub MODIFY_CODE_ATTRIBUTES {
- my ($class,$code,@attrs) = @_;
- $class->mk_classdata('__attr_cache' => {})
- unless $class->can('__attr_cache');
- $class->__attr_cache->{$code} = [@attrs];
- return ();
+ my ($class,$code,@attrs) = @_;
+ $class->mk_classdata('__attr_cache' => {})
+ unless $class->can('__attr_cache');
+ $class->__attr_cache->{$code} = [@attrs];
+ return ();
}
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 };
+ my $self = shift;
+ my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {};
+ my $rest = eval { $self->next::method };
+ return $@ ? $cache : { %$cache, %$rest };
}
+# SQLT version handling
+{
+ my $_sqlt_version_ok; # private
+ my $_sqlt_version_error; # private
+
+ sub _sqlt_version_ok {
+ if (!defined $_sqlt_version_ok) {
+ eval "use SQL::Translator $minimum_sqlt_version";
+ if ($@) {
+ $_sqlt_version_ok = 0;
+ $_sqlt_version_error = $@;
+ }
+ else {
+ $_sqlt_version_ok = 1;
+ }
+ }
+ return $_sqlt_version_ok;
+ }
+
+ sub _sqlt_version_error {
+ shift->_sqlt_version_ok unless defined $_sqlt_version_ok;
+ return $_sqlt_version_error;
+ }
+
+ sub _sqlt_minimum_version { $minimum_sqlt_version };
+}
+
+
1;
-=head1 NAME
+=head1 NAME
DBIx::Class - Extensible and flexible object <-> relational mapper.
+=head1 GETTING HELP/SUPPORT
+
+The community can be found via:
+
+ Mailing list: http://lists.scsys.co.uk/mailman/listinfo/dbix-class/
+
+ SVN: http://dev.catalyst.perl.org/repos/bast/DBIx-Class/
+
+ SVNWeb: http://dev.catalyst.perl.org/svnweb/bast/browse/DBIx-Class/
+
+ IRC: irc.perl.org#dbix-class
+
=head1 SYNOPSIS
-Create a base schema class called DB/Main.pm:
+Create a schema class called MyDB/Schema.pm:
- package DB::Main;
+ package MyDB::Schema;
use base qw/DBIx::Class::Schema/;
- __PACKAGE__->load_classes();
+ __PACKAGE__->load_namespaces();
1;
-Create a class the represent artists, who have many
-CDs, in DB/Main/Artist.pm:
+Create a result class to represent artists, who have many CDs, in
+MyDB/Schema/Result/Artist.pm:
- package DB::Main::Artist;
+See L<DBIx::Class::ResultSource> for docs on defining result classes.
+
+ package MyDB::Schema::Result::Artist;
use base qw/DBIx::Class/;
- __PACKAGE__->load_components(qw/PK::Auto Core/);
+ __PACKAGE__->load_components(qw/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 => 'MyDB::Schema::Result::CD');
1;
-A 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
+MyDB/Schema/Result/CD.pm:
- package DB::Main::CD;
+ package MyDB::Schema::Result::CD;
use base qw/DBIx::Class/;
- __PACKAGE__->load_components(qw/PK::Auto Core/);
+ __PACKAGE__->load_components(qw/Core/);
__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 => 'MyDB::Schema::Artist', 'artistid');
1;
Then you can use these classes in your application's code:
# Connect to your database.
- my $ds = DB::Main->connect(@dbi_dsn);
+ use MyDB::Schema;
+ my $schema = MyDB::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.
- my @all_artists = $ds->resultset('Artist')->all;
- my $all_artists_rs = $ds->resultset('Artist');
+ # $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 (@artists) {
+ print $artist->name, "\n";
+ }
# Create a result set to search for artists.
- # This does not query the DB, yet.
- my $johns_rs = $ds->resultset('Artist')->search(
+ # This does not query the DB.
+ my $johns_rs = $schema->resultset('Artist')->search(
# Build your WHERE using an SQL::Abstract structure:
- { 'name' => { 'like', 'John%' } }
+ { name => { like => 'John%' } }
);
- # Now the query is executed.
+ # Execute a joined query to get the cds.
my @all_john_cds = $johns_rs->search_related('cds')->all;
- # Queries but only fetches one row so far.
+ # Fetch the next available row.
my $first_john = $johns_rs->next;
+ # Specify ORDER BY on the query.
my $first_john_cds_by_title_rs = $first_john->cds(
undef,
{ order_by => 'title' }
);
- my $millenium_cds_rs = $ds->resultset('CD')->search(
+ # 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 },
{ prefetch => 'artist' }
);
- my $cd = $millenium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
- my $cd_artist_name = $cd->artist->name; # Already has the data so no query
+ my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
+ my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query
- my $new_cd = $ds->resultset('CD')->new({ title => 'Spoon' });
+ # new() makes a DBIx::Class::Row object but doesnt 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);
$new_cd->insert; # Auto-increment primary key filled in after INSERT
$new_cd->title('Fork');
- $ds->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
+ $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
- $millenium_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.
+JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and 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
-database when it actually needs to in order to return something the user's
-asked for. If a resultset is used as an iterator it only fetches rows off
-the statement 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).
+database in order to return something you've directly asked for. If a
+resultset is used as an iterator it only fetches rows off the statement
+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).
+
+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
+as bugs are found and fixed.
+
+We do our best to maintain full backwards compatibility for published
+APIs, since DBIx::Class is used in production in many organisations,
+and even backwards incompatible changes to non-published APIs will be fixed
+if they're reported and doing so doesn't cost the codebase anything.
+
+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.
-This project is still under rapid development, so features added in the
-latest major release may not work 100% yet - check the Changes if you run
-into trouble, and beware of anything explicitly marked EXPERIMENTAL. Failing
-test cases are *always* welcome and point releases are put out rapidly as
-bugs are found and fixed.
+=head1 WHERE TO GO NEXT
-Even so, we do your best to maintain full backwards compatibility for published
-APIs since DBIx::Class is used in production in a number of organisations;
-the test suite is now fairly substantial and several developer releases are
-generally made to CPAN before the -current branch is merged back to trunk.
+L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
+the modules where you will find documentation.
-The community can be found via -
+=head1 AUTHOR
- Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
+mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
- SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
+(I mostly consider myself "project founder" these days but the AUTHOR heading
+is traditional :)
- Wiki: http://dbix-class.shadowcatsystems.co.uk/
+=head1 CONTRIBUTORS
- IRC: irc.perl.org#dbix-class
+abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
-=head1 WHERE TO GO NEXT
+aherzog: Adam Herzog <adam@herzogdesigns.com>
-=over 4
+andyg: Andy Grundman <andy@hybridized.org>
-=item L<DBIx::Class::Manual> - user's manual
+ank: Andres Kievsky
-=item L<DBIx::Class::Core> - DBIC Core Classes
+arcanez: Justin Hunter <justin.d.hunter@gmail.com>
-=item L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
+ash: Ash Berlin <ash@cpan.org>
-=item L<DBIx::Class::Schema> - schema and connection container
+bert: Norbert Csongradi <bert@cpan.org>
-=item L<DBIx::Class::ResultSource> - tables and table-like things
+blblack: Brandon L. Black <blblack@gmail.com>
-=item L<DBIx::Class::ResultSet> - encapsulates a query and its results
+bluefeet: Aran Deltac <bluefeet@cpan.org>
-=item L<DBIx::Class::Row> - row-level methods
+bricas: Brian Cassidy <bricas@cpan.org>
-=item L<DBIx::Class::PK> - primary key methods
+caelum: Rafael Kitover <rkitover@cpan.org>
-=item L<DBIx::Class::Relationship> - relationships between tables
+castaway: Jess Robinson
-=back
+claco: Christopher H. Laco
-=head1 AUTHOR
+clkao: CL Kao
-Matt S. Trout <mst@shadowcatsystems.co.uk>
+da5id: David Jack Olrik <djo@cpan.org>
-=head1 CONTRIBUTORS
+debolaz: Anders Nor Berle <berle@cpan.org>
+
+dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
+
+dnm: Justin Wheeler <jwheeler@datademons.com>
+
+dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
+
+dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
-Alexander Hartmaier <alex_hartmaier@hotmail.com>
+frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
-Andy Grundman <andy@hybridized.org>
+gphat: Cory G Watson <gphat@cpan.org>
-Andres Kievsky
+groditi: Guillermo Roditi <groditi@cpan.org>
-Brandon Black
+ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
-Brian Cassidy <bricas@cpan.org>
+jasonmay: Jason May <jason.a.may@gmail.com>
-Christopher H. Laco
+jesper: Jesper Krogh
-CL Kao
+jgoulah: John Goulah <jgoulah@cpan.org>
-Daisuke Murase <typester@cpan.org>
+jguenther: Justin Guenther <jguenther@cpan.org>
-Dan Kubb <dan.kubb-cpan@onautopilot.com>
+jnapiorkowski: John Napiorkowski <jjn1056@yahoo.com>
-Dan Sully <daniel@cpan.org>
+jon: Jon Schutz <jjschutz@cpan.org>
-Daniel Westermann-Clark <danieltwc@cpan.org>
+jshirley: J. Shirley <jshirley@gmail.com>
-David Kamholz <dkamholz@cpan.org>
+konobi: Scott McWhirter
-Jesper Krogh
+lukes: Luke Saunders <luke.saunders@gmail.com>
-Jess Robinson
+marcus: Marcus Ramberg <mramberg@cpan.org>
-Jules Bean
+mattlaw: Matt Lawrence
-Justin Guenther <guentherj@agr.gc.ca>
+michaelr: Michael Reddick <michael.reddick@gmail.com>
-Marcus Ramberg <mramberg@cpan.org>
+ned: Neil de Carteret
-Nigel Metheringham <nigelm@cpan.org>
+nigel: Nigel Metheringham <nigelm@cpan.org>
-Paul Makepeace
+ningu: David Kamholz <dkamholz@cpan.org>
-Robert Sedlacek <phaylon@dunkelheit.at>
+Nniuq: Ron "Quinn" Straight" <quinnfazigu@gmail.org>
-sc_ of irc.perl.org#dbix-class
+norbi: Norbert Buchmuller <norbi@nix.hu>
-Scott McWhirter (konobi)
+Numa: Dan Sully <daniel@cpan.org>
-Scotty Allen <scotty@scottyallen.com>
+oyse: Øystein Torget <oystein.torget@dnv.com>
+
+paulm: Paul Makepeace
+
+penguin: K J Cheetham
+
+perigrin: Chris Prather <chris@prather.org>
+
+peter: Peter Collingbourne <peter@pcc.me.uk>
+
+phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
+
+plu: Johannes Plunien <plu@cpan.org>
+
+quicksilver: Jules Bean
+
+rafl: Florian Ragwitz <rafl@debian.org>
+
+rbuels: Robert Buels <rmb32@cornell.edu>
+
+rdj: Ryan D Johnson <ryan@innerfence.com>
+
+ribasushi: Peter Rabbitson <rabbit+dbic@rabbit.us>
+
+rjbs: Ricardo Signes <rjbs@cpan.org>
+
+robkinyon: Rob Kinyon <rkinyon@cpan.org>
+
+sc_: Just Another Perl Hacker
+
+scotty: Scotty Allen <scotty@scottyallen.com>
+
+semifor: Marc Mims <marc@questright.com>
+
+solomon: Jared Johnson <jaredj@nmgi.com>
+
+spb: Stephen Bennett <stephen@freenode.net>
+
+sszabo: Stephan Szabo <sszabo@bigpanda.com>
+
+teejay : Aaron Trevena <teejay@cpan.org>
Todd Lipcon
-Will Hawes
+Tom Hukins
+
+typester: Daisuke Murase <typester@cpan.org>
+
+victori: Victor Igumnov <victori@cpan.org>
+
+wdh: Will Hawes
+
+willert: Sebastian Willert <willert@cpan.org>
+
+wreis: Wallace Reis <wreis@cpan.org>
+
+zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2005 - 2009 the DBIx::Class L</AUTHOR> and L</CONTRIBUTORS>
+as listed above.
=head1 LICENSE
-You may distribute this code under the same terms as Perl itself.
+This library is free software and may be distributed under the same terms
+as perl itself.
=cut
-