@@ -95,6 +95,10 @@ sub _attr_cache {
95
95
96
96
1;
97
97
98
+ __END__
99
+
100
+ =encoding UTF-8
101
+
98
102
=head1 NAME
99
103
100
104
DBIx::Class - Extensible and flexible object <-> relational mapper.
@@ -131,41 +135,11 @@ list below is sorted by "fastest response time":
131
135
132
136
=back
133
137
134
- =head1 HOW TO CONTRIBUTE
135
-
136
- Contributions are always welcome, in all usable forms (we especially
137
- welcome documentation improvements). The delivery methods include git-
138
- or unified-diff formatted patches, GitHub pull requests, or plain bug
139
- reports either via RT or the Mailing list. Contributors are generally
140
- granted full access to the official repository after their first patch
141
- passes successful review.
142
-
143
- =for comment
144
- FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;)
145
-
146
- This project is maintained in a git repository. The code and related tools are
147
- accessible at the following locations:
148
-
149
- =over
150
-
151
- =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git>
152
-
153
- =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git>
154
-
155
- =item * GitHub mirror: L<https://github.com/dbsrgits/DBIx-Class>
156
-
157
- =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/DBIx-Class.git>
158
-
159
- =item * Travis-CI log: L<https://travis-ci.org/dbsrgits/dbix-class/builds>
160
-
161
- =for html
162
- <br>↪ Stable branch CI status: <img src="https://secure.travis-ci.org/dbsrgits/dbix-class.png?branch=master"></img>
163
-
164
- =back
165
-
166
138
=head1 SYNOPSIS
167
139
168
- Create a schema class called MyApp/Schema.pm:
140
+ =head2 Schema classes preparation
141
+
142
+ Create a schema class called F<MyApp/Schema.pm> :
169
143
170
144
package MyApp::Schema;
171
145
use base qw/DBIx::Class::Schema/;
@@ -175,7 +149,7 @@ Create a schema class called MyApp/Schema.pm:
175
149
1;
176
150
177
151
Create a result class to represent artists, who have many CDs, in
178
- MyApp/Schema/Result/Artist.pm:
152
+ F< MyApp/Schema/Result/Artist.pm> :
179
153
180
154
See L<DBIx::Class::ResultSource> for docs on defining result classes.
181
155
@@ -190,7 +164,7 @@ See L<DBIx::Class::ResultSource> for docs on defining result classes.
190
164
1;
191
165
192
166
A result class to represent a CD, which belongs to an artist, in
193
- MyApp/Schema/Result/CD.pm:
167
+ F< MyApp/Schema/Result/CD.pm> :
194
168
195
169
package MyApp::Schema::Result::CD;
196
170
use base qw/DBIx::Class::Core/;
@@ -203,6 +177,8 @@ MyApp/Schema/Result/CD.pm:
203
177
204
178
1;
205
179
180
+ =head2 API usage
181
+
206
182
Then you can use these classes in your application's code:
207
183
208
184
# Connect to your database.
@@ -271,7 +247,8 @@ that allows abstract encapsulation of database operations. It aims to make
271
247
representing queries in your code as perl-ish as possible while still
272
248
providing access to as many of the capabilities of the database as possible,
273
249
including retrieving related records from multiple tables in a single query,
274
- JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and HAVING support.
250
+ C<JOIN > , C<LEFT JOIN > , C<COUNT > , C<DISTINCT > , C<GROUP BY > , C<ORDER BY > and
251
+ C<HAVING > support.
275
252
276
253
DBIx::Class can handle multi-column primary and foreign keys, complex
277
254
queries and database-level paging, and does its best to only query the
@@ -284,8 +261,8 @@ and thread-safe out of the box (although
284
261
L<your DBD may not be|DBI/Threads and Thread Safety> ).
285
262
286
263
This project is still under rapid development, so large new features may be
287
- marked EXPERIMENTAL - such APIs are still usable but may have edge bugs.
288
- Failing test cases are * always* welcome and point releases are put out rapidly
264
+ marked B< experimental > - such APIs are still usable but may have edge bugs.
265
+ Failing test cases are I< always > welcome and point releases are put out rapidly
289
266
as bugs are found and fixed.
290
267
291
268
We do our best to maintain full backwards compatibility for published
@@ -297,6 +274,38 @@ The test suite is quite substantial, and several developer releases
297
274
are generally made to CPAN before the branch for the next release is
298
275
merged back to trunk for a major release.
299
276
277
+ =head1 HOW TO CONTRIBUTE
278
+
279
+ Contributions are always welcome, in all usable forms (we especially
280
+ welcome documentation improvements). The delivery methods include git-
281
+ or unified-diff formatted patches, GitHub pull requests, or plain bug
282
+ reports either via RT or the Mailing list. Contributors are generally
283
+ granted full access to the official repository after their first patch
284
+ passes successful review.
285
+
286
+ =for comment
287
+ FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;)
288
+
289
+ This project is maintained in a git repository. The code and related tools are
290
+ accessible at the following locations:
291
+
292
+ =over
293
+
294
+ =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class.git>
295
+
296
+ =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git>
297
+
298
+ =item * GitHub mirror: L<https://github.com/dbsrgits/DBIx-Class>
299
+
300
+ =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/DBIx-Class.git>
301
+
302
+ =item * Travis-CI log: L<https://travis-ci.org/dbsrgits/dbix-class/builds>
303
+
304
+ =for html
305
+ ↪ Stable branch CI status: <img src="https://secure.travis-ci.org/dbsrgits/dbix-class.png?branch=master"></img>
306
+
307
+ =back
308
+
300
309
=head1 AUTHOR
301
310
302
311
mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
@@ -362,8 +371,12 @@ clkao: CL Kao
362
371
363
372
da5id: David Jack Olrik <djo@cpan.org>
364
373
374
+ dariusj: Darius Jokilehto <dariusjokilehto@yahoo.co.uk>
375
+
365
376
davewood: David Schmidt <davewood@gmx.at>
366
377
378
+ daxim: Lars Dɪᴇᴄᴋᴏᴡ 迪拉斯 <daxim@cpan.org>
379
+
367
380
debolaz: Anders Nor Berle <berle@cpan.org>
368
381
369
382
dew: Dan Thomas <dan@godders.org>
@@ -563,5 +576,3 @@ as listed above.
563
576
564
577
This library is free software and may be distributed under the same terms
565
578
as perl itself.
566
-
567
- =cut
0 commit comments