X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=be2a8931bcf27182912f6f2b420a3196622067c3;hb=0c1a4a15ae0eb261ff8aabfd6383ddf1d822d690;hp=5d7a16636655b3575c142d52a3a1d04d893632df;hpb=bd93520f2fc007efd8d0062f44b611cb00072b7d;p=dbsrgits%2FDBIx-Class.git
diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm
index 5d7a166..be2a893 100644
--- a/lib/DBIx/Class.pm
+++ b/lib/DBIx/Class.pm
@@ -3,31 +3,50 @@ package DBIx::Class;
use strict;
use warnings;
+use MRO::Compat;
+use mro 'c3';
+
+use DBIx::Class::Optional::Dependencies;
+
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.08123_01';
-$VERSION = '0.06999_02';
+$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 ();
+ 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 : {};
+
+ return {
+ %$cache,
+ %{ $self->maybe::next::method || {} },
+ };
}
1;
@@ -36,65 +55,97 @@ sub _attr_cache {
DBIx::Class - Extensible and flexible object <-> relational mapper.
+=head1 GETTING HELP/SUPPORT
+
+The community can be found via:
+
+=over
+
+=item * IRC: irc.perl.org#dbix-class
+
+=for html
+(click for instant chatroom login)
+
+=item * Mailing list: L
+
+=item * RT Bug Tracker: L
+
+=item * gitweb: L
+
+=item * git: L
+
+=back
+
=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 result class to represent artists, who have many CDs, in
+MyDB/Schema/Result/Artist.pm:
- package DB::Main::Artist;
- use base qw/DBIx::Class/;
+See L for docs on defining result classes.
+
+ package MyDB::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 => 'MyDB::Schema::Result::CD');
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
+MyDB/Schema/Result/CD.pm:
- package DB::Main::CD;
- use base qw/DBIx::Class/;
+ package MyDB::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 => '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.
+ # $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(
- # Build your WHERE using an L structure:
+ # Build your WHERE using an SQL::Abstract structure:
{ name => { like => 'John%' } }
);
# 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.
@@ -103,7 +154,7 @@ Then you can use these classes in your application's code:
{ 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 },
@@ -111,8 +162,10 @@ Then you can use these classes in your application's code:
);
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
@@ -120,17 +173,18 @@ Then you can use these classes in your application's code:
$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
-(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
@@ -141,27 +195,19 @@ 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 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.
+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.
-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.
+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 community can be found via:
-
- Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
-
- SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
-
- 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
@@ -172,69 +218,197 @@ the modules where you will find documentation.
mst: Matt S. Trout
+(I mostly consider myself "project founder" these days but the AUTHOR heading
+is traditional :)
+
=head1 CONTRIBUTORS
-abraxxa: Alexander Hartmaier
+abraxxa: Alexander Hartmaier
+
+aherzog: Adam Herzog
+
+Alexander Keusch
+
+amoore: Andrew Moore
andyg: Andy Grundman
ank: Andres Kievsky
-blblack: Brandon Black
+arcanez: Justin Hunter
+
+ash: Ash Berlin
+
+bert: Norbert Csongradi
+
+blblack: Brandon L. Black
bluefeet: Aran Deltac
-LTJake: Brian Cassidy
+boghead: Bryan Beeley
+
+bricas: Brian Cassidy
+
+brunov: Bruno Vecchi
+
+caelum: Rafael Kitover
+
+castaway: Jess Robinson
claco: Christopher H. Laco
clkao: CL Kao
-typester: Daisuke Murase
+da5id: David Jack Olrik
+
+debolaz: Anders Nor Berle
+
+dew: Dan Thomas
dkubb: Dan Kubb
-Numa: Dan Sully
+dnm: Justin Wheeler
+
+dpetrov: Dimitar Petrov
dwc: Daniel Westermann-Clark
-ningu: David Kamholz
+dyfrgi: Michael Leuchtenburg
+
+frew: Arthur Axel "fREW" Schmidt
+
+goraxe: Gordon Irving
+
+gphat: Cory G Watson
+
+groditi: Guillermo Roditi
+
+Haarg: Graham Knop
+
+hobbs: Andrew Rodland
+
+ilmari: Dagfinn Ilmari MannsEker
+
+jasonmay: Jason May
jesper: Jesper Krogh
-castaway: Jess Robinson
+jgoulah: John Goulah
-quicksilver: Jules Bean
+jguenther: Justin Guenther
+
+jhannah: Jay Hannah
+
+jnapiorkowski: John Napiorkowski
+
+jon: Jon Schutz
+
+jshirley: J. Shirley
+
+konobi: Scott McWhirter
-jguenther: Justin Guenther
+lukes: Luke Saunders
-captainL: Luke Saunders
+marcus: Marcus Ramberg
-draven: Marcus Ramberg
+mattlaw: Matt Lawrence
+
+michaelr: Michael Reddick
+
+ned: Neil de Carteret
nigel: Nigel Metheringham
+ningu: David Kamholz
+
+Nniuq: Ron "Quinn" Straight"
+
+norbi: Norbert Buchmuller
+
+nuba: Nuba Princigalli
+
+Numa: Dan Sully
+
+ovid: Curtis "Ovid" Poe
+
+oyse: Øystein Torget
+
paulm: Paul Makepeace
+penguin: K J Cheetham
+
+perigrin: Chris Prather
+
+peter: Peter Collingbourne
+
phaylon: Robert Sedlacek
-sc_: Just Another Perl Hacker
+plu: Johannes Plunien
-konobi: Scott McWhirter
+Possum: Daniel LeWarne
+
+quicksilver: Jules Bean
+
+rafl: Florian Ragwitz
+
+rainboxx: Matthias Dietrich
+
+rbo: Robert Bohne
+
+rbuels: Robert Buels
+
+rdj: Ryan D Johnson
+
+ribasushi: Peter Rabbitson
+
+rjbs: Ricardo Signes
+
+robkinyon: Rob Kinyon
+
+Roman: Roman Filippov
+
+sc_: Just Another Perl Hacker
scotty: Scotty Allen
+semifor: Marc Mims
+
+solomon: Jared Johnson
+
+spb: Stephen Bennett
+
sszabo: Stephan Szabo
+teejay : Aaron Trevena
+
Todd Lipcon
+Tom Hukins
+
+tonvoon: Ton Voon
+
+triode: Pete Gamache
+
+typester: Daisuke Murase
+
+victori: Victor Igumnov
+
wdh: Will Hawes
-gphat: Cory G Watson
+willert: Sebastian Willert
+
+wreis: Wallace Reis
+
+zamolxes: Bogdan Lucaciu
+
+=head1 COPYRIGHT
+
+Copyright (c) 2005 - 2010 the DBIx::Class L and L
+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
-