more TODOs
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class.pm
1 package DBIx::Class;
2
3 use strict;
4 use warnings;
5
6 use vars qw($VERSION);
7 use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
8
9 sub mk_classdata { shift->mk_classaccessor(@_); }
10 sub component_base_class { 'DBIx::Class' }
11
12 # Always remember to do all digits for the version even if they're 0
13 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
14 # brain damage and presumably various other packaging systems too
15
16 $VERSION = '0.06000';
17
18 sub MODIFY_CODE_ATTRIBUTES {
19     my ($class,$code,@attrs) = @_;
20     $class->mk_classdata('__attr_cache' => {})
21       unless $class->can('__attr_cache');
22     $class->__attr_cache->{$code} = [@attrs];
23     return ();
24 }
25
26 sub _attr_cache {
27     my $self = shift;
28     my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {};
29     my $rest = eval { $self->next::method };
30     return $@ ? $cache : { %$cache, %$rest };
31 }
32
33 1;
34
35 =head1 NAME
36
37 DBIx::Class - Extensible and flexible object <-> relational mapper.
38
39 =head1 SYNOPSIS
40
41 Create a schema class called DB/Main.pm:
42
43   package DB::Main;
44   use base qw/DBIx::Class::Schema/;
45
46   __PACKAGE__->load_classes();
47
48   1;
49
50 Create a table class to represent artists, who have many CDs, in DB/Main/Artist.pm:
51
52   package DB::Main::Artist;
53   use base qw/DBIx::Class/;
54
55   __PACKAGE__->load_components(qw/PK::Auto Core/);
56   __PACKAGE__->table('artist');
57   __PACKAGE__->add_columns(qw/ artistid name /);
58   __PACKAGE__->set_primary_key('artistid');
59   __PACKAGE__->has_many(cds => 'DB::Main::CD');
60
61   1;
62
63 A table class to represent a CD, which belongs to an artist, in DB/Main/CD.pm:
64
65   package DB::Main::CD;
66   use base qw/DBIx::Class/;
67
68   __PACKAGE__->load_components(qw/PK::Auto Core/);
69   __PACKAGE__->table('cd');
70   __PACKAGE__->add_columns(qw/ cdid artist title year /);
71   __PACKAGE__->set_primary_key('cdid');
72   __PACKAGE__->belongs_to(artist => 'DB::Main::Artist');
73
74   1;
75
76 Then you can use these classes in your application's code:
77
78   # Connect to your database.
79   use DB::Main;
80   my $schema = DB::Main->connect($dbi_dsn, $user, $pass, \%dbi_params);
81
82   # Query for all artists and put them in an array,
83   # or retrieve them as a result set object.
84   my @all_artists = $schema->resultset('Artist')->all;
85   my $all_artists_rs = $schema->resultset('Artist');
86
87   # Create a result set to search for artists.
88   # This does not query the DB.
89   my $johns_rs = $schema->resultset('Artist')->search(
90     # Build your WHERE using an L<SQL::Abstract> structure:
91     { name => { like => 'John%' } }
92   );
93
94   # Execute a joined query to get the cds.
95   my @all_john_cds = $johns_rs->search_related('cds')->all;
96
97   # Fetch only the next row.
98   my $first_john = $johns_rs->next;
99
100   # Specify ORDER BY on the query.
101   my $first_john_cds_by_title_rs = $first_john->cds(
102     undef,
103     { order_by => 'title' }
104   );
105
106   # Create a result set that will fetch the artist relationship
107   # at the same time as it fetches CDs, using only one query.
108   my $millennium_cds_rs = $schema->resultset('CD')->search(
109     { year => 2000 },
110     { prefetch => 'artist' }
111   );
112
113   my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
114   my $cd_artist_name = $cd->artist->name; # Already has the data so no query
115
116   my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
117   $new_cd->artist($cd->artist);
118   $new_cd->insert; # Auto-increment primary key filled in after INSERT
119   $new_cd->title('Fork');
120
121   $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
122
123   $millennium_cds_rs->update({ year => 2002 }); # Single-query bulk update
124
125 =head1 DESCRIPTION
126
127 This is an SQL to OO mapper with an object API inspired by L<Class::DBI>
128 (and a compatibility layer as a springboard for porting) and a resultset API
129 that allows abstract encapsulation of database operations. It aims to make
130 representing queries in your code as perl-ish as possible while still
131 providing access to as many of the capabilities of the database as possible,
132 including retrieving related records from multiple tables in a single query,
133 JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY and HAVING support.
134
135 DBIx::Class can handle multi-column primary and foreign keys, complex
136 queries and database-level paging, and does its best to only query the
137 database in order to return something you've directly asked for. If a
138 resultset is used as an iterator it only fetches rows off the statement
139 handle as requested in order to minimise memory usage. It has auto-increment
140 support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is
141 known to be used in production on at least the first four, and is fork-
142 and thread-safe out of the box (although your DBD may not be).
143
144 This project is still under rapid development, so features added in the
145 latest major release may not work 100% yet -- check the Changes if you run
146 into trouble, and beware of anything explicitly marked EXPERIMENTAL. Failing
147 test cases are *always* welcome and point releases are put out rapidly as
148 bugs are found and fixed.
149
150 Even so, we do our best to maintain full backwards compatibility for published
151 APIs, since DBIx::Class is used in production in a number of organisations.
152 The test suite is quite substantial, and several developer releases are
153 generally made to CPAN before the -current branch is merged back to trunk for
154 a major release.
155
156 The community can be found via:
157
158   Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
159
160   SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
161
162   Wiki: http://dbix-class.shadowcatsystems.co.uk/
163
164   IRC: irc.perl.org#dbix-class
165
166 =head1 WHERE TO GO NEXT
167
168 =over 4
169
170 =item L<DBIx::Class::Manual> - user's manual
171
172 =item L<DBIx::Class::Core> - DBIC Core Classes
173
174 =item L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
175
176 =item L<DBIx::Class::Schema> - schema and connection container
177
178 =item L<DBIx::Class::ResultSource> - tables and table-like things
179
180 =item L<DBIx::Class::ResultSet> - encapsulates a query and its results
181
182 =item L<DBIx::Class::Row> - row-level methods
183
184 =item L<DBIx::Class::PK> - primary key methods
185
186 =item L<DBIx::Class::Relationship> - relationships between tables
187
188 =back
189
190 =head1 AUTHOR
191
192 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
193
194 =head1 CONTRIBUTORS
195
196 abraxxa: Alexander Hartmaier <alex_hartmaier@hotmail.com>
197
198 andyg: Andy Grundman <andy@hybridized.org>
199
200 ank: Andres Kievsky
201
202 blblack: Brandon Black
203
204 LTJake: Brian Cassidy <bricas@cpan.org>
205
206 claco: Christopher H. Laco
207
208 clkao: CL Kao
209
210 typester: Daisuke Murase <typester@cpan.org>
211
212 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
213
214 Numa: Dan Sully <daniel@cpan.org>
215
216 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
217
218 ningu: David Kamholz <dkamholz@cpan.org>
219
220 jesper: Jesper Krogh
221
222 castaway: Jess Robinson
223
224 quicksilver: Jules Bean
225
226 jguenther: Justin Guenther <guentherj@agr.gc.ca>
227
228 draven: Marcus Ramberg <mramberg@cpan.org>
229
230 nigel: Nigel Metheringham <nigelm@cpan.org>
231
232 paulm: Paul Makepeace
233
234 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
235
236 sc_: Just Another Perl Hacker
237
238 konobi: Scott McWhirter
239
240 scotty: Scotty Allen <scotty@scottyallen.com>
241
242 sszabo: Stephan Szabo <sszabo@bigpanda.com>
243
244 Todd Lipcon
245
246 wdh: Will Hawes
247
248 =head1 LICENSE
249
250 You may distribute this code under the same terms as Perl itself.
251
252 =cut
253