use vars qw($VERSION);
use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/;
+use DBIx::Class::StartupCheck;
+
sub mk_classdata {
- my $self = shift;
- $self->mk_group_accessors('inherited', $_[0]);
- $self->set_inherited(@_) if @_ > 1;
+ 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' }
# 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.07999_02';
+$VERSION = '0.08099_06';
+
+$VERSION = eval $VERSION; # numify for warning-free dev releases
sub MODIFY_CODE_ATTRIBUTES {
my ($class,$code,@attrs) = @_;
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 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 table class to represent artists, who have many CDs, in DB/Main/Artist.pm:
+Create a table class to represent artists, who have many CDs, in
+MyDB/Schema/Result/Artist.pm:
- package DB::Main::Artist;
+ 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 table class to represent a CD, which belongs to an artist, in DB/Main/CD.pm:
+A table 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.
- use DB::Main;
- my $schema = DB::Main->connect($dbi_dsn, $user, $pass, \%dbi_params);
+ 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.
# 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.
+ # 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
$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.
+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
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 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.
-
-Even so, we do our 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 quite substantial, and several developer releases are
-generally made to CPAN before the -current branch is merged back to trunk for
-a major release.
-
-The community can be found via:
-
- Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
+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.
- SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
+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.
- Wiki: http://dbix-class.shadowcatsystems.co.uk/
-
- IRC: irc.perl.org#dbix-class
+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
mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
+(I mostly consider myself "project founder" these days but the AUTHOR heading
+is traditional :)
+
=head1 CONTRIBUTORS
abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
+aherzog: Adam Herzog <adam@herzogdesigns.com>
+
andyg: Andy Grundman <andy@hybridized.org>
ank: Andres Kievsky
ash: Ash Berlin <ash@cpan.org>
+bert: Norbert Csongradi <bert@cpan.org>
+
blblack: Brandon L. Black <blblack@gmail.com>
bluefeet: Aran Deltac <bluefeet@cpan.org>
+bricas: Brian Cassidy <bricas@cpan.org>
+
+caelum: Rafael Kitover <rkitover@cpan.org>
+
captainL: Luke Saunders <luke.saunders@gmail.com>
castaway: Jess Robinson
clkao: CL Kao
+da5id: David Jack Olrik <djo@cpan.org>
+
+debolaz: Anders Nor Berle <berle@cpan.org>
+
dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
-draven: Marcus Ramberg <mramberg@cpan.org>
+dnm: Justin Wheeler <jwheeler@datademons.com>
dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
gphat: Cory G Watson <gphat@cpan.org>
+groditi: Guillermo Roditi <groditi@cpan.org>
+
jesper: Jesper Krogh
+jgoulah: John Goulah <jgoulah@cpan.org>
+
jguenther: Justin Guenther <jguenther@cpan.org>
+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>
+marcus: Marcus Ramberg <mramberg@cpan.org>
+
+mattlaw: Matt Lawrence
ned: Neil de Carteret
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>
+plu: Johannes Plunien <plu@cpan.org>
+
quicksilver: Jules Bean
+rafl: Florian Ragwitz <rafl@debian.org>
+
+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>
+
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>
zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
+norbi: Norbert Buchmuller <norbi@nix.hu>
+
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
projects / dbsrgits/DBIx-Class.git / blobdiff