use warnings;
use vars qw($VERSION);
-use base qw/DBIx::Class::Componentised/;
+use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
-$VERSION = '0.03002';
+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.06999_02';
+
+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 = 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:
+
+ package DB::Main;
+ use base qw/DBIx::Class::Schema/;
+
+ __PACKAGE__->load_classes();
+
+ 1;
+
+Create a table class to represent artists, who have many CDs, in DB/Main/Artist.pm:
+
+ package DB::Main::Artist;
+ use base qw/DBIx::Class/;
+
+ __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');
+
+ 1;
+
+A table class to represent a CD, which belongs to an artist, in DB/Main/CD.pm:
+
+ package DB::Main::CD;
+ use base qw/DBIx::Class/;
+
+ __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');
+
+ 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);
+
+ # 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');
+
+ # 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<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.
+ 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' }
+ );
-This is a sql to oop mapper, inspired by the L<Class::DBI> 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.
+ # 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' }
+ );
-It's currently considered EXPERIMENTAL - bring this near a production
-database at your own risk! The API is *not* fixed yet, although most of
-the primitives should be good for the future and any API changes will be
-posted to the mailing list before they're committed.
+ 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
-The community can be found via -
+ 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
+
+ $millennium_cds_rs->update({ year => 2002 }); # Single-query bulk update
+
+=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
+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:
Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
IRC: irc.perl.org#dbix-class
-=head1 QUICKSTART
+=head1 WHERE TO GO NEXT
+
+L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
+the modules where you will find documentation.
-If you're using Class::DBI, replacing
+=head1 AUTHOR
- use base qw/Class::DBI/;
+mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
-with
+=head1 CONTRIBUTORS
- use base qw/DBIx::Class/;
- __PACKAGE__->load_components(qw/CDBICompat Core DB/);
+abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
-will probably get you started.
+andyg: Andy Grundman <andy@hybridized.org>
-If you're using AUTO_INCREMENT for your primary columns, you'll also want
-yo load the approriate PK::Auto subclass - e.g.
+ank: Andres Kievsky
- __PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core DB/);
+blblack: Brandon Black
-(with is what ::Test::SQLite does to present the Class::DBI::Test::SQLite
-interface)
+bluefeet: Aran Deltac <bluefeet@cpan.org>
-If you fancy playing around with DBIx::Class from scratch, then read the docs
-for DBIx::Class::Table, ::Row, ::Schema, ::DB and ::Relationship,
+LTJake: Brian Cassidy <bricas@cpan.org>
- use base qw/DBIx::Class/;
- __PACKAGE__->load_components(qw/Core DB/);
+claco: Christopher H. Laco
-and have a look at t/lib/DBICTest.pm for a brief example.
+clkao: CL Kao
-=head1 AUTHOR
+typester: Daisuke Murase <typester@cpan.org>
-Matt S. Trout <mst@shadowcatsystems.co.uk>
+dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
-=head1 CONTRIBUTORS
+Numa: Dan Sully <daniel@cpan.org>
+
+dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
+
+ningu: David Kamholz <dkamholz@cpan.org>
+
+jesper: Jesper Krogh
+
+castaway: Jess Robinson
+
+quicksilver: Jules Bean
+
+jguenther: Justin Guenther <guentherj@agr.gc.ca>
+
+captainL: Luke Saunders <luke.saunders@gmail.com>
+
+draven: Marcus Ramberg <mramberg@cpan.org>
+
+nigel: Nigel Metheringham <nigelm@cpan.org>
+
+paulm: Paul Makepeace
+
+phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
+
+sc_: Just Another Perl Hacker
-Andy Grundman <andy@hybridized.org>
+konobi: Scott McWhirter
-Brian Cassidy <bricas@cpan.org>
+scotty: Scotty Allen <scotty@scottyallen.com>
-Dan Kubb <dan.kubb-cpan@onautopilot.com>
+sszabo: Stephan Szabo <sszabo@bigpanda.com>
-Dan Sully <daniel@cpan.org>
+Todd Lipcon
-davekam
+wdh: Will Hawes
-Marcus Ramberg <mramberg@cpan.org>
+gphat: Cory G Watson <gphat@cpan.org>
=head1 LICENSE
projects / dbsrgits/DBIx-Class.git / blobdiff