use warnings;
use vars qw($VERSION);
-use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
+use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/;
+
+
+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.05007';
+$VERSION = '0.08002';
sub MODIFY_CODE_ATTRIBUTES {
- my ($class,$code,@attrs) = @_;
- unless ($class->can('_attr_cache')) {
- $class->mk_classdata('_attr_cache');
- $class->_attr_cache({});
- }
- my $cache = $class->_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 };
}
1;
-=head1 NAME
+=head1 NAME
DBIx::Class - Extensible and flexible object <-> relational mapper.
=head1 SYNOPSIS
-=head1 DESCRIPTION
+Create a schema class called DB/Main.pm:
-This is an SQL to OO mapper, inspired by the L<Class::DBI> framework,
-and meant to support compability with it, while restructuring the
-internals and making it possible to support some new features like
-self-joins, distinct, group bys and more.
+ package DB::Main;
+ use base qw/DBIx::Class::Schema/;
-This project is still at an early stage, so the maintainers don't make
-any absolute promise that full backwards-compatibility will be supported;
-however, if we can without compromising the improvements we're trying to
-make, we will, and any non-compatible changes will merit a full justification
-on the mailing list and a CPAN developer release for people to test against.
+ __PACKAGE__->load_classes();
-The community can be found via -
+ 1;
- Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
+Create a table class to represent artists, who have many CDs, in DB/Main/Artist.pm:
- SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
+ package DB::Main::Artist;
+ use base qw/DBIx::Class/;
- Wiki: http://dbix-class.shadowcatsystems.co.uk/
+ __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');
- IRC: irc.perl.org#dbix-class
+ 1;
-=head1 QUICKSTART
+A table class to represent a CD, which belongs to an artist, in DB/Main/CD.pm:
-If you're using L<Class::DBI>, and want an easy and fast way of migrating to
-DBIx::Class, take a look at L<DBIx::Class::CDBICompat>.
+ package DB::Main::CD;
+ use base qw/DBIx::Class/;
-There are two ways of using DBIx::Class, the "simple" way and the "schema" way.
-The "simple" way of using DBIx::Class needs less classes than the "schema"
-way but doesn't give you the ability to easily use different database connections.
+ __PACKAGE__->load_components(qw/PK::Auto Core/);
+ __PACKAGE__->table('cd');
+ __PACKAGE__->add_columns(qw/ cdid artist title year /);
+ __PACKAGE__->set_primary_key('cdid');
+ __PACKAGE__->belongs_to(artist => 'DB::Main::Artist');
-Some examples where different database connections are useful are:
+ 1;
-different users with different rights
-different databases with the same schema.
+Then you can use these classes in your application's code:
-=head2 Simple
+ # Connect to your database.
+ use DB::Main;
+ my $schema = DB::Main->connect($dbi_dsn, $user, $pass, \%dbi_params);
-First you need to create a base class which all other classes will inherit from.
-See L<DBIx::Class::DB> for information on how to do this.
+ # Query for all artists and put them in an array,
+ # or retrieve them as a result set object.
+ my @all_artists = $schema->resultset('Artist')->all;
+ my $all_artists_rs = $schema->resultset('Artist');
-Then you need to create a class for every table you want to use with DBIx::Class.
-See L<DBIx::Class::Table> for information on how to do this.
+ # 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%' } }
+ );
-=head2 Schema
+ # Execute a joined query to get the cds.
+ my @all_john_cds = $johns_rs->search_related('cds')->all;
-With this approach, the table classes inherit directly from DBIx::Class::Core,
-although it might be a good idea to create a "parent" class for all table
-classes that inherits from DBIx::Class::Core and adds additional methods
-needed by all table classes, e.g. reading a config file or loading auto primary
-key support.
+ # Fetch only the next row.
+ my $first_john = $johns_rs->next;
-Look at L<DBIx::Class::Schema> for information on how to do this.
+ # Specify ORDER BY on the query.
+ my $first_john_cds_by_title_rs = $first_john->cds(
+ undef,
+ { order_by => 'title' }
+ );
-If you need more help, check out the introduction in the
-manual below.
+ # Create a result set that will fetch the artist relationship
+ # at the same time as it fetches CDs, using only one query.
+ my $millennium_cds_rs = $schema->resultset('CD')->search(
+ { year => 2000 },
+ { prefetch => 'artist' }
+ );
-=head1 SEE ALSO
+ 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
-=over 4
+ 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');
-=item L<DBIx::Class::Core> - DBIC Core Classes
+ $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
-=item L<DBIx::Class::Manual> - User's manual
+ $millennium_cds_rs->update({ year => 2002 }); # Single-query bulk update
-=item L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
+=head1 DESCRIPTION
-=item L<DBIx::Class::Schema>
+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
+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.
+
+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 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:
-=item L<DBIx::Class::ResultSet>
+ Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
-=item L<DBIx::Class::ResultSource>
+ SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
-=item L<DBIx::Class::Row> - row-level methods
+ Wiki: http://dbix-class.shadowcatsystems.co.uk/
-=item L<DBIx::Class::PK> - primary key methods
+ IRC: irc.perl.org#dbix-class
-=item L<DBIx::Class::Relationship> - relationships between tables
+=head1 WHERE TO GO NEXT
-=back
+L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
+the modules where you will find documentation.
=head1 AUTHOR
-Matt S. Trout <mst@shadowcatsystems.co.uk>
+mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
=head1 CONTRIBUTORS
-Andy Grundman <andy@hybridized.org>
+abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
-Brian Cassidy <bricas@cpan.org>
+andyg: Andy Grundman <andy@hybridized.org>
-Dan Kubb <dan.kubb-cpan@onautopilot.com>
+ank: Andres Kievsky
-Dan Sully <daniel@cpan.org>
+ash: Ash Berlin <ash@cpan.org>
-David Kamholz <dkamholz@cpan.org>
+blblack: Brandon L. Black <blblack@gmail.com>
-Jules Bean
+bluefeet: Aran Deltac <bluefeet@cpan.org>
-Marcus Ramberg <mramberg@cpan.org>
+captainL: Luke Saunders <luke.saunders@gmail.com>
-Paul Makepeace
+castaway: Jess Robinson
-CL Kao
+claco: Christopher H. Laco
-Jess Robinson
+clkao: CL Kao
-Marcus Ramberg
+da5id: David Jack Olrik <djo@cpan.org>
-Will Hawes
+dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
-Todd Lipcon
+dnm: Justin Wheeler <jwheeler@datademons.com>
+
+draven: Marcus Ramberg <mramberg@cpan.org>
-Daniel Westermann-Clark <danieltwc@cpan.org>
+dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
-Alexander Hartmaier <alex_hartmaier@hotmail.com>
+dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
-Zbigniew Lukasiak
+gphat: Cory G Watson <gphat@cpan.org>
-Nigel Metheringham <nigelm@cpan.org>
+jesper: Jesper Krogh
-Jesper Krogh
+jguenther: Justin Guenther <jguenther@cpan.org>
-Brandon Black
+jshirley: J. Shirley <jshirley@gmail.com>
-Christopher H. Laco
+konobi: Scott McWhirter
-Scotty Allen <scotty@scottyallen.com>
+LTJake: Brian Cassidy <bricas@cpan.org>
-sc_
+ned: Neil de Carteret
+
+nigel: Nigel Metheringham <nigelm@cpan.org>
+
+ningu: David Kamholz <dkamholz@cpan.org>
+
+Numa: Dan Sully <daniel@cpan.org>
+
+paulm: Paul Makepeace
+
+penguin: K J Cheetham
+
+phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
+
+quicksilver: Jules Bean
+
+sc_: Just Another Perl Hacker
+
+scotty: Scotty Allen <scotty@scottyallen.com>
+
+sszabo: Stephan Szabo <sszabo@bigpanda.com>
+
+Todd Lipcon
+
+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
-
projects / dbsrgits/DBIx-Class.git / blobdiff