use warnings;
use vars qw($VERSION);
-use base qw/DBIx::Class::Componentised Class::Data::Inheritable/;
+use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
-$VERSION = '0.03999_02';
+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.05999_04';
+
+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 SYNOPSIS
-=head1 DESCRIPTION
+Create a base schema class called DB/Main.pm:
-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.
+ 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 class the 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;
+
+A 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');
-=head1 QUICKSTART
+ 1;
-If you're using Class::DBI, and want an easy and fast way of migrating to
-DBIx::Class look at L<DBIx::Class::CDBICompat>.
+Then you can use these classes in your application's code:
-There are two ways of using DBIx::Class, the 'simple' and the 'schema' one.
+ # Connect to your database.
+ my $ds = DB::Main->connect(@dbi_dsn);
-The 'simple' way of using DBIx::Class needs less classes than the 'schema'
-way but doesn't give you the ability to use different database connections.
+ # Query for all artists and put them in an array,
+ # or retrieve them as a result set object.
+ my @all_artists = $ds->resultset('Artist')->all;
+ my $all_artists_rs = $ds->resultset('Artist');
-Some examples where different database connections are useful are:
+ # Create a result set to search for artists.
+ # This does not query the DB, yet.
+ my $johns_rs = $ds->resultset('Artist')->search(
+ # Build your WHERE using an SQL::Abstract structure:
+ { 'name' => { 'like', 'John%' } }
+ );
-different users with different rights
-different databases with the same schema.
+ # Now the query is executed.
+ my @all_john_cds = $johns_rs->search_related('cds')->all;
-=head1 Simple
+ # Queries but only fetches one row so far.
+ my $first_john = $johns_rs->next;
-First you need to create a base class all other classes inherit from.
+ my $first_john_cds_by_title_rs = $first_john->cds(
+ undef,
+ { order_by => 'title' }
+ );
-Look at L<DBIx::Class::DB> how to do this
+ my $millenium_cds_rs = $ds->resultset('CD')->search(
+ { year => 2000 },
+ { prefetch => 'artist' }
+ );
-Next you need to create a class for every table you want to use with
-DBIx::Class.
+ my $cd = $millenium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
+ my $cd_artist_name = $cd->artist->name; # Already has the data so no query
-Look at L<DBIx::Class::Table> how to do this.
+ my $new_cd = $ds->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');
+ $ds->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
-=head2 Schema
+ $millenium_cds_rs->update({ year => 2002 }); # Single-query bulk update
-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 which inherits from DBIx::Class::Core and adds additional methods
-needed by all table classes, e.g. reading a config file, loading auto primary
-key support.
+=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 when it actually needs to in order to return something the user's
+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 your 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 now fairly substantial and several developer releases are
+generally made to CPAN before the -current branch is merged back to trunk.
+
+The community can be found via -
+
+ Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
-Look at L<DBIx::Class::Schema> how to do this.
+ SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
+
+ Wiki: http://dbix-class.shadowcatsystems.co.uk/
-If you need more hand-holding, check out the introduction in the
-manual below.
+ IRC: irc.perl.org#dbix-class
-=head1 SEE ALSO
+=head1 WHERE TO GO NEXT
=over 4
+=item L<DBIx::Class::Manual> - user's manual
+
=item L<DBIx::Class::Core> - DBIC Core Classes
-=item L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer.
+=item L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
+
+=item L<DBIx::Class::Schema> - schema and connection container
-=item L<DBIx::Class::Manual> - User's manual.
+=item L<DBIx::Class::ResultSource> - tables and table-like things
+
+=item L<DBIx::Class::ResultSet> - encapsulates a query and its results
+
+=item L<DBIx::Class::Row> - row-level methods
+
+=item L<DBIx::Class::PK> - primary key methods
+
+=item L<DBIx::Class::Relationship> - relationships between tables
=back
=head1 CONTRIBUTORS
+Alexander Hartmaier <alex_hartmaier@hotmail.com>
+
Andy Grundman <andy@hybridized.org>
+Andres Kievsky
+
+Brandon Black
+
Brian Cassidy <bricas@cpan.org>
+Christopher H. Laco
+
+CL Kao
+
+Daisuke Murase <typester@cpan.org>
+
Dan Kubb <dan.kubb-cpan@onautopilot.com>
Dan Sully <daniel@cpan.org>
-davekam
+Daniel Westermann-Clark <danieltwc@cpan.org>
+
+David Kamholz <dkamholz@cpan.org>
+
+Jesper Krogh
+
+Jess Robinson
+
+Jules Bean
+
+Justin Guenther <guentherj@agr.gc.ca>
Marcus Ramberg <mramberg@cpan.org>
+Nigel Metheringham <nigelm@cpan.org>
+
+Paul Makepeace
+
+Robert Sedlacek <phaylon@dunkelheit.at>
+
+sc_ of irc.perl.org#dbix-class
+
+Scott McWhirter (konobi)
+
+Scotty Allen <scotty@scottyallen.com>
+
+Todd Lipcon
+
+Will Hawes
+
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.