X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass.pm;h=7aba89577410c77921e2a180d9a66c1e22d07433;hb=20674fcd94984d0d2be09ecda7f3c22715468936;hp=9cb1b369f42fe66ae824ac0f10dc9c658e78a9a3;hpb=8b445e337a0dbacf4ccb827211002f8d691ad671;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 9cb1b36..7aba895 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -3,73 +3,404 @@ package DBIx::Class; use strict; use warnings; +use MRO::Compat; +use mro 'c3'; + +use DBIx::Class::Optional::Dependencies; + use vars qw($VERSION); -use base; +use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/; +use DBIx::Class::StartupCheck; +use Try::Tiny; -$VERSION = '0.01'; +sub mk_classdata { + shift->mk_classaccessor(@_); +} -sub load_components { - my $class = shift; - my @comp = map { "DBIx::Class::$_" } grep { $_ !~ /^#/ } @_; - foreach my $comp (@comp) { - eval "use $comp"; - die $@ if $@; - } - no strict 'refs'; - unshift(@{"${class}::ISA"}, @comp); +sub mk_classaccessor { + my $self = shift; + $self->mk_group_accessors('inherited', $_[0]); + $self->set_inherited(@_) if @_ > 1; +} + +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.08121_01'; + +$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 (); +} + +sub _attr_cache { + my $self = shift; + my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {}; + my $rest; + my $exception; + try { + $rest = $self->next::method; + } catch { + $exception = 1; + }; + return $exception ? $cache : { %$cache, %$rest }; } 1; -=head1 NAME +=head1 NAME + +DBIx::Class - Extensible and flexible object <-> relational mapper. + +=head1 GETTING HELP/SUPPORT + +The community can be found via: + +=over + +=item * IRC: L + +=item * Mailing list: L -DBIx::Class - Because the brain is a terrible thing to waste. +=item * RT Bug Tracker: L + +=item * SVNWeb: L + +=item * SVN: L + +=back =head1 SYNOPSIS +Create a schema class called MyDB/Schema.pm: + + package MyDB::Schema; + use base qw/DBIx::Class::Schema/; + + __PACKAGE__->load_namespaces(); + + 1; + +Create a result class to represent artists, who have many CDs, in +MyDB/Schema/Result/Artist.pm: + +See L for docs on defining result classes. + + package MyDB::Schema::Result::Artist; + use base qw/DBIx::Class::Core/; + + __PACKAGE__->table('artist'); + __PACKAGE__->add_columns(qw/ artistid name /); + __PACKAGE__->set_primary_key('artistid'); + __PACKAGE__->has_many(cds => 'MyDB::Schema::Result::CD'); + + 1; + +A result class to represent a CD, which belongs to an artist, in +MyDB/Schema/Result/CD.pm: + + package MyDB::Schema::Result::CD; + use base qw/DBIx::Class::Core/; + + __PACKAGE__->load_components(qw/InflateColumn::DateTime/); + __PACKAGE__->table('cd'); + __PACKAGE__->add_columns(qw/ cdid artistid title year /); + __PACKAGE__->set_primary_key('cdid'); + __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 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 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 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' } + ); + + # 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 = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ... + 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 + $new_cd->title('Fork'); + + $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction + + # change the year of all the millennium CDs at once + $millennium_cds_rs->update({ year => 2002 }); + =head1 DESCRIPTION -This is a sql to oop mapper, inspired by the L framework, -and meant to support compability with it, while restructuring the -insides, and making it possible to support some new features like -self-joins, distinct, group bys and more. +This is an SQL to OO mapper with an object API inspired by L +(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, 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 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. + +=head1 WHERE TO GO NEXT + +L lists each task you might want help on, and +the modules where you will find documentation. + +=head1 AUTHOR + +mst: Matt S. Trout + +(I mostly consider myself "project founder" these days but the AUTHOR heading +is traditional :) + +=head1 CONTRIBUTORS + +abraxxa: Alexander Hartmaier + +aherzog: Adam Herzog + +amoore: Andrew Moore + +andyg: Andy Grundman + +ank: Andres Kievsky + +arcanez: Justin Hunter + +ash: Ash Berlin + +bert: Norbert Csongradi -=head1 QUICKSTART +blblack: Brandon L. Black -If you're using Class::DBI, replacing +bluefeet: Aran Deltac -use base qw/Class::DBI/; +boghead: Bryan Beeley -with +bricas: Brian Cassidy -use base qw/DBIx::Class/; -__PACKAGE__->load_components(qw/CDBICompat Core/); +brunov: Bruno Vecchi -will probably get you started. +caelum: Rafael Kitover -If you're using AUTO_INCREMENT for your primary columns, you'll also want -yo load the approriate PK::Auto subclass - e.g. +castaway: Jess Robinson -__PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core/); +claco: Christopher H. Laco -(with is what ::Test::SQLite does to present the Class::DBI::Test::SQLite -interface) +clkao: CL Kao -If you fancy playing around with DBIx::Class from scratch, then read the docs -for ::Table and ::Relationship, +da5id: David Jack Olrik -use base qw/DBIx::Class/; -__PACKAGE__->load_components(qw/Core/); +debolaz: Anders Nor Berle -and have a look at t/lib/DBICTest.pm for a brief example. +dew: Dan Thomas -=head1 AUTHORS +dkubb: Dan Kubb -Matt S. Trout +dnm: Justin Wheeler + +dpetrov: Dimitar Petrov + +dwc: Daniel Westermann-Clark + +dyfrgi: Michael Leuchtenburg + +frew: Arthur Axel "fREW" Schmidt + +goraxe: Gordon Irving + +gphat: Cory G Watson + +groditi: Guillermo Roditi + +hobbs: Andrew Rodland + +ilmari: Dagfinn Ilmari MannsEker + +jasonmay: Jason May + +jesper: Jesper Krogh + +jgoulah: John Goulah + +jguenther: Justin Guenther + +jhannah: Jay Hannah + +jnapiorkowski: John Napiorkowski + +jon: Jon Schutz + +jshirley: J. Shirley + +konobi: Scott McWhirter + +lukes: Luke Saunders + +marcus: 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 + +plu: Johannes Plunien + +quicksilver: Jules Bean + +rafl: Florian Ragwitz + +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 + +triode: Pete Gamache + +typester: Daisuke Murase + +victori: Victor Igumnov + +wdh: Will Hawes + +willert: Sebastian Willert + +wreis: Wallace Reis + +zamolxes: Bogdan Lucaciu + +Possum: Daniel LeWarne + +=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 -