Commit | Line | Data |
ea2e61bf |
1 | package DBIx::Class; |
2 | |
95b76469 |
3 | # important to load early |
4 | use DBIx::Class::_Util; |
5 | |
5d283305 |
6 | use strict; |
7 | use warnings; |
8 | |
f9cc85ce |
9 | our $VERSION; |
10 | # Always remember to do all digits for the version even if they're 0 |
11 | # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports |
12 | # brain damage and presumably various other packaging systems too |
13 | |
14 | # $VERSION declaration must stay up here, ahead of any other package |
15 | # declarations, as to not confuse various modules attempting to determine |
16 | # this ones version, whether that be s.c.o. or Module::Metadata, etc |
c6b73be9 |
17 | $VERSION = '0.082899_15'; |
f9cc85ce |
18 | |
19 | $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases |
20 | |
d38cd95c |
21 | use mro 'c3'; |
329d7385 |
22 | |
db29433c |
23 | use base qw/DBIx::Class::Componentised DBIx::Class::AccessorGroup/; |
f9080e45 |
24 | use DBIx::Class::Exception; |
3e110410 |
25 | |
a8eaf44b |
26 | __PACKAGE__->mk_classaccessor( |
27 | _skip_namespace_frames => join( '|', map { '^' . $_ } qw( |
28 | DBIx::Class |
29 | SQL::Abstract |
30 | SQL::Translator |
31 | Try::Tiny |
32 | Class::Accessor::Grouped |
33 | Context::Preserve |
34 | Moose::Meta:: |
35 | )), |
5f48fa56 |
36 | ); |
70c28808 |
37 | |
d009cb7d |
38 | sub component_base_class { 'DBIx::Class' } |
77d518d1 |
39 | |
d095c62d |
40 | # *DO NOT* change this URL nor the identically named =head1 below |
41 | # it is linked throughout the ecosystem |
42 | sub DBIx::Class::_ENV_::HELP_URL () { |
43 | 'http://p3rl.org/DBIx::Class#GETTING_HELP/SUPPORT' |
44 | } |
45 | |
ea2e61bf |
46 | 1; |
34d52be2 |
47 | |
d095c62d |
48 | __END__ |
49 | |
75d07914 |
50 | =head1 NAME |
34d52be2 |
51 | |
7e4b2f59 |
52 | DBIx::Class - Extensible and flexible object <-> relational mapper. |
34d52be2 |
53 | |
06752a03 |
54 | =head1 WHERE TO START READING |
3b1c2bbd |
55 | |
06752a03 |
56 | See L<DBIx::Class::Manual::DocMap> for an overview of the exhaustive documentation. |
57 | To get the most out of DBIx::Class with the least confusion it is strongly |
58 | recommended to read (at the very least) the |
59 | L<Manuals|DBIx::Class::Manual::DocMap/Manuals> in the order presented there. |
60 | |
32250d01 |
61 | =cut |
62 | |
32250d01 |
63 | =head1 GETTING HELP/SUPPORT |
06752a03 |
64 | |
32250d01 |
65 | Due to the sheer size of its problem domain, DBIx::Class is a relatively |
06752a03 |
66 | complex framework. After you start using DBIx::Class questions will inevitably |
67 | arise. If you are stuck with a problem or have doubts about a particular |
32250d01 |
68 | approach do not hesitate to contact us via any of the following options (the |
69 | list is sorted by "fastest response time"): |
3b1c2bbd |
70 | |
a06e1181 |
71 | =over |
3b1c2bbd |
72 | |
c6fdaf2a |
73 | =item * IRC: irc.perl.org#dbix-class |
74 | |
75 | =for html |
e1ddfc8a |
76 | <a href="https://chat.mibbit.com/#dbix-class@irc.perl.org">(click for instant chatroom login)</a> |
3b1c2bbd |
77 | |
a06e1181 |
78 | =item * Mailing list: L<http://lists.scsys.co.uk/mailman/listinfo/dbix-class> |
3b1c2bbd |
79 | |
e1ddfc8a |
80 | =item * RT Bug Tracker: L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=DBIx-Class> |
86a23587 |
81 | |
e1ddfc8a |
82 | =item * Twitter: L<https://www.twitter.com/dbix_class> |
86a23587 |
83 | |
86a23587 |
84 | =item * Web Site: L<http://www.dbix-class.org/> |
a06e1181 |
85 | |
86a23587 |
86 | =back |
87 | |
34d52be2 |
88 | =head1 SYNOPSIS |
89 | |
113e8d16 |
90 | For the very impatient: L<DBIx::Class::Manual::QuickStart> |
91 | |
92 | This code in the next step can be generated automatically from an existing |
93 | database, see L<dbicdump> from the distribution C<DBIx-Class-Schema-Loader>. |
94 | |
5b56d1ac |
95 | =head2 Schema classes preparation |
96 | |
53aa53f3 |
97 | Create a schema class called F<MyApp/Schema.pm>: |
34d52be2 |
98 | |
03460bef |
99 | package MyApp::Schema; |
a0638a7b |
100 | use base qw/DBIx::Class::Schema/; |
34d52be2 |
101 | |
f0bb26f3 |
102 | __PACKAGE__->load_namespaces(); |
daec44b8 |
103 | |
a0638a7b |
104 | 1; |
daec44b8 |
105 | |
30e1753a |
106 | Create a result class to represent artists, who have many CDs, in |
53aa53f3 |
107 | F<MyApp/Schema/Result/Artist.pm>: |
daec44b8 |
108 | |
30e1753a |
109 | See L<DBIx::Class::ResultSource> for docs on defining result classes. |
110 | |
03460bef |
111 | package MyApp::Schema::Result::Artist; |
d88ecca6 |
112 | use base qw/DBIx::Class::Core/; |
daec44b8 |
113 | |
a0638a7b |
114 | __PACKAGE__->table('artist'); |
115 | __PACKAGE__->add_columns(qw/ artistid name /); |
116 | __PACKAGE__->set_primary_key('artistid'); |
326dacbf |
117 | __PACKAGE__->has_many(cds => 'MyApp::Schema::Result::CD', 'artistid'); |
daec44b8 |
118 | |
a0638a7b |
119 | 1; |
daec44b8 |
120 | |
30e1753a |
121 | A result class to represent a CD, which belongs to an artist, in |
53aa53f3 |
122 | F<MyApp/Schema/Result/CD.pm>: |
39fe0e65 |
123 | |
03460bef |
124 | package MyApp::Schema::Result::CD; |
d88ecca6 |
125 | use base qw/DBIx::Class::Core/; |
39fe0e65 |
126 | |
d88ecca6 |
127 | __PACKAGE__->load_components(qw/InflateColumn::DateTime/); |
a0638a7b |
128 | __PACKAGE__->table('cd'); |
bd077b47 |
129 | __PACKAGE__->add_columns(qw/ cdid artistid title year /); |
a0638a7b |
130 | __PACKAGE__->set_primary_key('cdid'); |
03460bef |
131 | __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Result::Artist', 'artistid'); |
39fe0e65 |
132 | |
a0638a7b |
133 | 1; |
39fe0e65 |
134 | |
5b56d1ac |
135 | =head2 API usage |
136 | |
a0638a7b |
137 | Then you can use these classes in your application's code: |
39fe0e65 |
138 | |
a0638a7b |
139 | # Connect to your database. |
03460bef |
140 | use MyApp::Schema; |
141 | my $schema = MyApp::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params); |
a0638a7b |
142 | |
143 | # Query for all artists and put them in an array, |
144 | # or retrieve them as a result set object. |
30e1753a |
145 | # $schema->resultset returns a DBIx::Class::ResultSet |
2053ab2a |
146 | my @all_artists = $schema->resultset('Artist')->all; |
147 | my $all_artists_rs = $schema->resultset('Artist'); |
126042ee |
148 | |
30e1753a |
149 | # Output all artists names |
4e8ffded |
150 | # $artist here is a DBIx::Class::Row, which has accessors |
16ccb4fe |
151 | # for all its columns. Rows are also subclasses of your Result class. |
85067746 |
152 | foreach $artist (@all_artists) { |
30e1753a |
153 | print $artist->name, "\n"; |
154 | } |
155 | |
a0638a7b |
156 | # Create a result set to search for artists. |
86beca1d |
157 | # This does not query the DB. |
2053ab2a |
158 | my $johns_rs = $schema->resultset('Artist')->search( |
6576ef54 |
159 | # Build your WHERE using an SQL::Abstract structure: |
2053ab2a |
160 | { name => { like => 'John%' } } |
a0638a7b |
161 | ); |
39fe0e65 |
162 | |
2053ab2a |
163 | # Execute a joined query to get the cds. |
a0638a7b |
164 | my @all_john_cds = $johns_rs->search_related('cds')->all; |
448c8424 |
165 | |
f0bb26f3 |
166 | # Fetch the next available row. |
a0638a7b |
167 | my $first_john = $johns_rs->next; |
448c8424 |
168 | |
2053ab2a |
169 | # Specify ORDER BY on the query. |
a0638a7b |
170 | my $first_john_cds_by_title_rs = $first_john->cds( |
171 | undef, |
172 | { order_by => 'title' } |
173 | ); |
448c8424 |
174 | |
bd077b47 |
175 | # Create a result set that will fetch the artist data |
2053ab2a |
176 | # at the same time as it fetches CDs, using only one query. |
884559b1 |
177 | my $millennium_cds_rs = $schema->resultset('CD')->search( |
a0638a7b |
178 | { year => 2000 }, |
179 | { prefetch => 'artist' } |
180 | ); |
448c8424 |
181 | |
880a1a0c |
182 | my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ... |
bd077b47 |
183 | my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query |
076652e8 |
184 | |
4b0a90fd |
185 | # new() makes a Result object but doesn't insert it into the DB. |
264f1571 |
186 | # create() is the same as new() then insert(). |
884559b1 |
187 | my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' }); |
f183eccd |
188 | $new_cd->artist($cd->artist); |
f183eccd |
189 | $new_cd->insert; # Auto-increment primary key filled in after INSERT |
f183eccd |
190 | $new_cd->title('Fork'); |
191 | |
884559b1 |
192 | $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction |
f183eccd |
193 | |
bd077b47 |
194 | # change the year of all the millennium CDs at once |
195 | $millennium_cds_rs->update({ year => 2002 }); |
f183eccd |
196 | |
197 | =head1 DESCRIPTION |
198 | |
199 | This is an SQL to OO mapper with an object API inspired by L<Class::DBI> |
bd077b47 |
200 | (with a compatibility layer as a springboard for porting) and a resultset API |
f183eccd |
201 | that allows abstract encapsulation of database operations. It aims to make |
202 | representing queries in your code as perl-ish as possible while still |
a0638a7b |
203 | providing access to as many of the capabilities of the database as possible, |
f183eccd |
204 | including retrieving related records from multiple tables in a single query, |
53aa53f3 |
205 | C<JOIN>, C<LEFT JOIN>, C<COUNT>, C<DISTINCT>, C<GROUP BY>, C<ORDER BY> and |
206 | C<HAVING> support. |
f183eccd |
207 | |
208 | DBIx::Class can handle multi-column primary and foreign keys, complex |
209 | queries and database-level paging, and does its best to only query the |
75d07914 |
210 | database in order to return something you've directly asked for. If a |
211 | resultset is used as an iterator it only fetches rows off the statement |
212 | handle as requested in order to minimise memory usage. It has auto-increment |
2053ab2a |
213 | support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is |
214 | known to be used in production on at least the first four, and is fork- |
ec6415a9 |
215 | and thread-safe out of the box (although |
9361b05d |
216 | L<your DBD may not be|DBI/Threads and Thread Safety>). |
f183eccd |
217 | |
dfccde48 |
218 | This project is still under rapid development, so large new features may be |
53aa53f3 |
219 | marked B<experimental> - such APIs are still usable but may have edge bugs. |
220 | Failing test cases are I<always> welcome and point releases are put out rapidly |
dfccde48 |
221 | as bugs are found and fixed. |
222 | |
223 | We do our best to maintain full backwards compatibility for published |
224 | APIs, since DBIx::Class is used in production in many organisations, |
225 | and even backwards incompatible changes to non-published APIs will be fixed |
226 | if they're reported and doing so doesn't cost the codebase anything. |
227 | |
264f1571 |
228 | The test suite is quite substantial, and several developer releases |
229 | are generally made to CPAN before the branch for the next release is |
230 | merged back to trunk for a major release. |
f183eccd |
231 | |
6ed05cfd |
232 | =head1 HOW TO CONTRIBUTE |
233 | |
234 | Contributions are always welcome, in all usable forms (we especially |
235 | welcome documentation improvements). The delivery methods include git- |
236 | or unified-diff formatted patches, GitHub pull requests, or plain bug |
237 | reports either via RT or the Mailing list. Contributors are generally |
cb32addc |
238 | granted access to the official repository after their first several |
239 | patches pass successful review. Don't hesitate to |
240 | L<contact|/GETTING HELP/SUPPORT> either of the L</CAT HERDERS> with |
241 | any further questions you may have. |
6ed05cfd |
242 | |
243 | =for comment |
244 | FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;) |
245 | |
246 | This project is maintained in a git repository. The code and related tools are |
247 | accessible at the following locations: |
248 | |
249 | =over |
250 | |
251 | =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git> |
252 | |
253 | =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git> |
254 | |
255 | =item * GitHub mirror: L<https://github.com/dbsrgits/DBIx-Class> |
256 | |
257 | =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/DBIx-Class.git> |
258 | |
259 | =item * Travis-CI log: L<https://travis-ci.org/dbsrgits/dbix-class/builds> |
260 | |
261 | =for html |
33d0570d |
262 | ↪ Bleeding edge dev CI status: <img src="https://secure.travis-ci.org/dbsrgits/dbix-class.png?branch=master"></img> |
6ed05cfd |
263 | |
264 | =back |
265 | |
3440100b |
266 | =head1 AUTHORS |
34d52be2 |
267 | |
3440100b |
268 | Even though a large portion of the source I<appears> to be written by just a |
269 | handful of people, this library continues to remain a collaborative effort - |
270 | perhaps one of the most successful such projects on L<CPAN|http://cpan.org>. |
271 | It is important to remember that ideas do not always result in a direct code |
272 | contribution, but deserve acknowledgement just the same. Time and time again |
273 | the seemingly most insignificant questions and suggestions have been shown |
274 | to catalyze monumental improvements in consistency, accuracy and performance. |
34d52be2 |
275 | |
3440100b |
276 | =for comment this line is replaced with the author list at dist-building time |
dfccde48 |
277 | |
3440100b |
278 | The canonical source of authors and their details is the F<AUTHORS> file at |
279 | the root of this distribution (or repository). The canonical source of |
280 | per-line authorship is the L<git repository|/HOW TO CONTRIBUTE> history |
281 | itself. |
f9139687 |
282 | |
cb32addc |
283 | =head1 CAT HERDERS |
284 | |
285 | The fine folks nudging the project in a particular direction: |
286 | |
287 | =over |
288 | |
f06eb015 |
289 | B<ribasushi>: Peter Rabbitson <ribasushi@cpan.org> |
cb32addc |
290 | (present day maintenance and controlled evolution) |
291 | |
f06eb015 |
292 | B<castaway>: Jess Robinson <castaway@desert-island.me.uk> |
cb32addc |
293 | (lions share of the reference documentation and manuals) |
294 | |
f06eb015 |
295 | B<mst>: Matt S Trout <mst@shadowcat.co.uk> (project founder - |
cb32addc |
296 | original idea, architecture and implementation) |
297 | |
298 | =back |
299 | |
a2bd3796 |
300 | =head1 COPYRIGHT AND LICENSE |
b38e10bd |
301 | |
a2bd3796 |
302 | Copyright (c) 2005 by mst, castaway, ribasushi, and other DBIx::Class |
303 | L</AUTHORS> as listed above and in F<AUTHORS>. |
96154ef7 |
304 | |
305 | This library is free software and may be distributed under the same terms |
a2bd3796 |
306 | as perl5 itself. See F<LICENSE> for the complete licensing terms. |