forked from Perl5/DBIx-Class
/
Relationship.pm
348 lines (244 loc) · 12.5 KB
/
Relationship.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
package DBIx::Class::Relationship;
use strict;
use warnings;
use base qw/DBIx::Class/;
__PACKAGE__->load_own_components(qw/
Helpers
Accessor
CascadeActions
ProxyMethods
Base
/);
=head1 NAME
DBIx::Class::Relationship - Inter-table relationships
=head1 SYNOPSIS
MyDB::Schema::Actor->has_many('actorroles' => 'MyDB::Schema::ActorRole',
'actor');
MyDB::Schema::Role->has_many('actorroles' => 'MyDB::Schema::ActorRole',
'role');
MyDB::Schema::ActorRole->belongs_to('role' => 'MyDB::Schema::Role');
MyDB::Schema::ActorRole->belongs_to('actor' => 'MyDB::Schema::Actor');
MyDB::Schema::Role->many_to_many('actors' => 'actorroles', 'actor');
MyDB::Schema::Actor->many_to_many('roles' => 'actorroles', 'role');
$schema->resultset('Actor')->roles();
$schema->resultset('Role')->search_related('actors', { Name => 'Fred' });
$schema->resultset('ActorRole')->add_to_roles({ Name => 'Sherlock Holmes'});
See L<DBIx::Class::Manual::Cookbook> for more.
=head1 DESCRIPTION
This class provides methods to set up relationships between the tables
in your database model. Relationships are the most useful and powerful
technique that L<DBIx::Class> provides. To create efficient database queries,
create relationships between any and all tables that have something in
common, for example if you have a table Authors:
ID | Name | Age
------------------
1 | Fred | 30
2 | Joe | 32
and a table Books:
ID | Author | Name
--------------------
1 | 1 | Rulers of the universe
2 | 1 | Rulers of the galaxy
Then without relationships, the method of getting all books by Fred goes like
this:
my $fred = $schema->resultset('Author')->find({ Name => 'Fred' });
my $fredsbooks = $schema->resultset('Book')->search({ Author => $fred->ID });
With a has_many relationship called "books" on Author (see below for details),
we can do this instead:
my $fredsbooks = $schema->resultset('Author')->find({ Name => 'Fred' })->books;
Each relationship sets up an accessor method on the
L<DBIx::Class::Manual::Glossary/"Row"> objects that represent the items
of your table. From L<DBIx::Class::Manual::Glossary/"ResultSet"> objects,
the relationships can be searched using the "search_related" method.
In list context, each returns a list of Row objects for the related class,
in scalar context, a new ResultSet representing the joined tables is
returned. Thus, the calls can be chained to produce complex queries.
Since the database is not actually queried until you attempt to retrieve
the data for an actual item, no time is wasted producing them.
my $cheapfredbooks = $schema->resultset('Author')->find({
Name => 'Fred',
})->books->search_related('prices', {
Price => { '<=' => '5.00' },
});
will produce a query something like:
SELECT * FROM Author me
LEFT JOIN Books books ON books.author = me.id
LEFT JOIN Prices prices ON prices.book = books.id
WHERE prices.Price <= 5.00
all without needing multiple fetches.
Only the helper methods for setting up standard relationship types
are documented here. For the basic, lower-level methods, and a description
of all the useful *_related methods that you get for free, see
L<DBIx::Class::Relationship::Base>.
=head1 METHODS
All helper methods take the following arguments:
__PACKAGE__>$method_name('relname', 'Foreign::Class', $cond, $attrs);
Both C<$cond> and C<$attrs> are optional. Pass C<undef> for C<$cond> if
you want to use the default value for it, but still want to set C<$attrs>.
See L<DBIx::Class::Relationship::Base> for a list of valid attributes and valid
relationship attributes.
=head2 belongs_to
=over 4
=item Arguments: $accessor_name, $related_class, $foreign_key_column|$cond?, $attr?
=back
# in a Book class (where Author has many Books)
My::DBIC::Schema::Book->belongs_to( author => 'My::DBIC::Schema::Author' );
my $author_obj = $obj->author; # get author object
$obj->author( $new_author_obj ); # set author object
The above belongs_to relationship could also have been specified as,
My::DBIC::Schema::Book->belongs_to( author,
'My::DBIC::Schema::Author',
{ 'foreign.author' => 'self.author' } );
Creates a relationship where the calling class stores the foreign class's
primary key in one (or more) of its columns. This relationship defaults to
using C<$accessor_name> as the foreign key in C<$related_class> to resolve the
join, unless C<$foreign_key_column> specifies the foreign key column in
C<$related_class> or C<$cond> specifies a reference to a join condition hash.
If the relationship is optional -- i.e. the column containing the foreign key
can be NULL -- then the belongs_to relationship does the right thing. Thus, in
the example above C<$obj-E<gt>author> would return C<undef>. However in this
case you would probably want to set the C<join_type> attribute so that a C<LEFT
JOIN> is done, which makes complex resultsets involving C<join> or C<prefetch>
operations work correctly. The modified declaration is shown below:
# in a Book class (where Author has_many Books)
__PACKAGE__->belongs_to(author => 'My::DBIC::Schema::Author',
'author', {join_type => 'left'});
Cascading deletes are off by default on a C<belongs_to>
relationship. To turn them on, pass C<< cascade_delete => 1 >>
in the $attr hashref.
NOTE: If you are used to L<Class::DBI> relationships, this is the equivalent
of C<has_a>.
See L<DBIx::Class::Relationship::Base> for documentation on relationship
methods and valid relationship attributes.
=head2 has_many
=over 4
=item Arguments: $accessor_name, $related_class, $foreign_key_column|$cond?, $attr?
=back
# in an Author class (where Author has_many Books)
My::DBIC::Schema::Author->has_many(books => 'My::DBIC::Schema::Book', 'author');
my $booklist = $obj->books;
my $booklist = $obj->books({
name => { LIKE => '%macaroni%' },
{ prefetch => [qw/book/],
});
my @book_objs = $obj->books;
my $books_rs = $obj->books;
( $books_rs ) = $obj->books_rs;
$obj->add_to_books(\%col_data);
The above C<has_many> relationship could also have been specified with an
explicit join condition:
My::DBIC::Schema::Author->has_many( books => 'My::DBIC::Schema::Book', {
'foreign.author' => 'self.author',
});
Creates a one-to-many relationship, where the corresponding elements of the
foreign class store the calling class's primary key in one (or more) of its
columns. This relationship defaults to using C<$accessor_name> as the foreign
key in C<$related_class> to resolve the join, unless C<$foreign_key_column>
specifies the foreign key column in C<$related_class> or C<$cond> specifies a
reference to a join condition hash.
Three methods are created when you create a has_many relationship. The first
method is the expected accessor method, C<$accessor_name()>. The second is
almost exactly the same as the accessor method but "_rs" is added to the end of
the method name. This method works just like the normal accessor, except that
it returns a resultset no matter what, even in list context. The third method,
named C<< add_to_$relname >>, will also be added to your Row items; this
allows you to insert new related items, using the same mechanism as in
L<DBIx::Class::Relationship::Base/"create_related">.
If you delete an object in a class with a C<has_many> relationship, all
the related objects will be deleted as well. To turn this behaviour off,
pass C<< cascade_delete => 0 >> in the C<$attr> hashref. However, any
database-level cascade or restrict will take precedence over a
DBIx-Class-based cascading delete.
See L<DBIx::Class::Relationship::Base> for documentation on relationship
methods and valid relationship attributes.
=head2 might_have
=over 4
=item Arguments: $accessor_name, $related_class, $foreign_key_column|$cond?, $attr?
=back
My::DBIC::Schema::Author->might_have( pseudonym =>
'My::DBIC::Schema::Pseudonym' );
my $pname = $obj->pseudonym; # to get the Pseudonym object
The above might_have relationship could have been specified as:
My::DBIC::Schema::Author->might_have( pseudonym =>
'My::DBIC::Schema::Pseudonym',
'author' );
Or even:
My::DBIC::Schema::Author->might_have( pseudonym =>
'My::DBIC::Schema::Pseudonym',
{ 'foreign.author' => 'self.author' } );
Assuming the Pseudonym table has
Creates an optional one-to-one relationship with a class. This relationship
defaults to using C<$accessor_name> as the foreign key in C<$related_class> to
resolve the join, unless C<$foreign_key_column> specifies the foreign key
column in C<$related_class> or C<$cond> specifies a reference to a join
condition hash.
If you update or delete an object in a class with a C<might_have>
relationship, the related object will be updated or deleted as well. To
turn off this behavior, add C<< cascade_delete => 0 >> to the C<$attr>
hashref. Any database-level update or delete constraints will override
this behavior.
See L<DBIx::Class::Relationship::Base> for documentation on relationship
methods and valid relationship attributes.
=head2 has_one
=over 4
=item Arguments: $accessor_name, $related_class_name, $join_condition?, $attr?
=back
My::DBIC::Schema::Book->has_one(isbn => 'My::DBIC::Schema::ISBN');
my $isbn_obj = $obj->isbn; # to get the ISBN object
Creates a one-to-one relationship with another class. This is just like
C<might_have>, except the implication is that the other object is always
present. The only difference between C<has_one> and C<might_have> is that
C<has_one> uses an (ordinary) inner join, whereas C<might_have> uses a
left join.
The has_one relationship should be used when a row in the table has exactly one
related row in another table. If the related row might not exist in the foreign
table, use the L<DBIx::Class::Relationship/might_have> relationship.
In the above example, each Book in the database is associated with exactly one
ISBN object.
See L<DBIx::Class::Relationship::Base> for documentation on relationship
methods and valid relationship attributes.
=head2 many_to_many
=over 4
=item Arguments: $accessor_name, $link_rel_name, $foreign_rel_name, $attr?
=back
To create a many_to_many relationship from Actor to Role:
My::DBIC::Schema::Actor->has_many( actor_roles =>
'My::DBIC::Schema::ActorRoles',
'actor' );
My::DBIC::Schema::ActorRoles->belongs_to( role =>
'My::DBIC::Schema::Role' );
My::DBIC::Schema::ActorRoles->belongs_to( actor =>
'My::DBIC::Schema::Actor' );
My::DBIC::Schema::Actor->many_to_many( roles => 'actor_roles',
'role' );
And, for the reverse relationship, from Role to Actor:
My::DBIC::Schema::Role->has_many( actor_roles =>
'My::DBIC::Schema::ActorRoles',
'role' );
My::DBIC::Schema::Role->many_to_many( actors => 'actor_roles', 'actor' );
Many_to_many is not strictly a relationship in its own right. Instead, it is
a bridge between two resultsets which provide the same kind of convenience
accessors as true relationships provide. Although the accessor will return a
resultset or collection of objects just like has_many does, you cannot call
C<$related_resultset> and similar methods which operate on true relationships.
In the above example, ActorRoles is the link table class, and Role is the
foreign class. The C<$link_rel_name> parameter is the name of the accessor for
the has_many relationship from this table to the link table, and the
C<$foreign_rel_name> parameter is the accessor for the belongs_to relationship
from the link table to the foreign table.
To use many_to_many, existing relationships from the original table to the link
table, and from the link table to the end table must already exist, these
relation names are then used in the many_to_many call.
In the above example, the Actor class will have 3 many_to_many accessor methods
set: C<$roles>, C<$add_to_roles>, C<$set_roles>, and similarly named accessors
will be created for the Role class for the C<actors> many_to_many
relationship.
See L<DBIx::Class::Relationship::Base> for documentation on relationship
methods and valid relationship attributes.
=cut
1;
=head1 AUTHORS
Matt S. Trout <mst@shadowcatsystems.co.uk>
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
=cut