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