1 package DBIx::Class::Relationship::Base;
6 use base qw/DBIx::Class/;
8 use Scalar::Util qw/weaken blessed/;
14 DBIx::Class::Relationship::Base - Inter-table relationships
18 __PACKAGE__->add_relationship(
19 spiders => 'My::DB::Result::Creatures',
23 "$args->{foreign_alias}.id" => { -ident => "$args->{self_alias}.id" },
24 "$args->{foreign_alias}.type" => 'arachnid'
31 This class provides methods to describe the relationships between the
32 tables in your database model. These are the "bare bones" relationships
33 methods, for predefined ones, look in L<DBIx::Class::Relationship>.
37 =head2 add_relationship
41 =item Arguments: 'relname', 'Foreign::Class', $condition, $attrs
45 __PACKAGE__->add_relationship('relname',
49 Create a custom relationship between one result source and another
50 source, indicated by its class name.
54 The condition argument describes the C<ON> clause of the C<JOIN>
55 expression used to connect the two sources when creating SQL queries.
57 =head4 Simple equality
59 To create simple equality joins, supply a hashref containing the remote
60 table column name as the key(s) prefixed by C<'foreign.'>, and the
61 corresponding local table column name as the value(s) prefixed by C<'self.'>.
62 Both C<foreign> and C<self> are pseudo aliases and must be entered
63 literally. They will be replaced with the actual correct table alias
64 when the SQL is produced.
68 My::Schema::Author->has_many(
69 books => 'My::Schema::Book',
70 { 'foreign.author_id' => 'self.id' }
75 $author_rs->search_related('books')->next
77 will result in the following C<JOIN> clause:
79 ... FROM author me LEFT JOIN book books ON books.author_id = me.id ...
81 This describes a relationship between the C<Author> table and the
82 C<Book> table where the C<Book> table has a column C<author_id>
83 containing the ID value of the C<Author>.
87 My::Schema::Book->has_many(
88 editions => 'My::Schema::Edition',
90 'foreign.publisher_id' => 'self.publisher_id',
91 'foreign.type_id' => 'self.type_id',
97 $book_rs->search_related('editions')->next
99 will result in the C<JOIN> clause:
102 LEFT JOIN edition editions ON
103 editions.publisher_id = me.publisher_id
104 AND editions.type_id = me.type_id ...
106 This describes the relationship from C<Book> to C<Edition>, where the
107 C<Edition> table refers to a publisher and a type (e.g. "paperback"):
109 =head4 Multiple groups of simple equality conditions
111 As is the default in L<SQL::Abstract>, the key-value pairs will be
112 C<AND>ed in the resulting C<JOIN> clause. An C<OR> can be achieved with
113 an arrayref. For example a condition like:
115 My::Schema::Item->has_many(
116 related_item_links => My::Schema::Item::Links,
118 { 'foreign.left_itemid' => 'self.id' },
119 { 'foreign.right_itemid' => 'self.id' },
123 will translate to the following C<JOIN> clause:
125 ... FROM item me JOIN item_relations related_item_links ON
126 related_item_links.left_itemid = me.id
127 OR related_item_links.right_itemid = me.id ...
129 This describes the relationship from C<Item> to C<Item::Links>, where
130 C<Item::Links> is a many-to-many linking table, linking items back to
131 themselves in a peer fashion (without a "parent-child" designation)
133 =head4 Custom join conditions
135 NOTE: The custom join condition specification mechanism is capable of
136 generating JOIN clauses of virtually unlimited complexity. This may limit
137 your ability to traverse some of the more involved relationship chains the
138 way you expect, *and* may bring your RDBMS to its knees. Exercise care
139 when declaring relationships as described here.
141 To specify joins which describe more than a simple equality of column
142 values, the custom join condition coderef syntax can be used. For
145 My::Schema::Artist->has_many(
146 cds_80s => 'My::Schema::CD',
151 "$args->{foreign_alias}.artist" => { -ident => "$args->{self_alias}.artistid" },
152 "$args->{foreign_alias}.year" => { '>', "1979", '<', "1990" },
159 $artist_rs->search_related('cds_80s')->next;
161 will result in the C<JOIN> clause:
163 ... FROM artist me LEFT JOIN cd cds_80s ON
164 cds_80s.artist = me.artistid
168 with the bind values:
172 C<< $args->{foreign_alias} >> and C<< $args->{self_alias} >> are supplied the
173 same values that would be otherwise substituted for C<foreign> and C<self>
174 in the simple hashref syntax case.
176 The coderef is expected to return a valid L<SQL::Abstract> query-structure, just
177 like what one would supply as the first argument to
178 L<DBIx::Class::ResultSet/search>. The return value will be passed directly to
179 L<SQL::Abstract> and the resulting SQL will be used verbatim as the C<ON>
180 clause of the C<JOIN> statement associated with this relationship.
182 While every coderef-based condition must return a valid C<ON> clause, it may
183 elect to additionally return a simplified join-free condition hashref when
184 invoked as C<< $result->relationship >>, as opposed to
185 C<< $rs->related_resultset('relationship') >>. In this case C<$result> is
186 passed to the coderef as C<< $args->{self_rowobj} >>, so a user can do the
194 "$args->{foreign_alias}.artist" => { -ident => "$args->{self_alias}.artistid" },
195 "$args->{foreign_alias}.year" => { '>', "1979", '<', "1990" },
197 $args->{self_rowobj} && {
198 "$args->{foreign_alias}.artist" => $args->{self_rowobj}->artistid,
199 "$args->{foreign_alias}.year" => { '>', "1979", '<', "1990" },
206 my $artist = $schema->resultset("Artist")->find({ id => 4 });
207 $artist->cds_80s->all;
209 Can skip a C<JOIN> altogether and instead produce:
211 SELECT cds_80s.cdid, cds_80s.artist, cds_80s.title, cds_80s.year, cds_80s.genreid, cds_80s.single_track
213 WHERE cds_80s.artist = ?
217 With the bind values:
221 Note that in order to be able to use
222 L<< $result->create_related|DBIx::Class::Relationship::Base/create_related >>,
223 the coderef must not only return as its second such a "simple" condition
224 hashref which does not depend on joins being available, but the hashref must
225 contain only plain values/deflatable objects, such that the result can be
226 passed directly to L<DBIx::Class::Relationship::Base/set_from_related>. For
227 instance the C<year> constraint in the above example prevents the relationship
228 from being used to create related objects (an exception will be thrown).
230 In order to allow the user to go truly crazy when generating a custom C<ON>
231 clause, the C<$args> hashref passed to the subroutine contains some extra
232 metadata. Currently the supplied coderef is executed as:
234 $relationship_info->{cond}->({
235 self_alias => The alias of the invoking resultset ('me' in case of a result object),
236 foreign_alias => The alias of the to-be-joined resultset (often matches relname),
237 self_resultsource => The invocant's resultsource,
238 foreign_relname => The relationship name (does *not* always match foreign_alias),
239 self_rowobj => The invocant itself in case of a $result_object->$relationship call
244 The L<standard ResultSet attributes|DBIx::Class::ResultSet/ATTRIBUTES> may
245 be used as relationship attributes. In particular, the 'where' attribute is
246 useful for filtering relationships:
248 __PACKAGE__->has_many( 'valid_users', 'MyApp::Schema::User',
249 { 'foreign.user_id' => 'self.user_id' },
250 { where => { valid => 1 } }
253 The following attributes are also valid:
259 Explicitly specifies the type of join to use in the relationship. Any SQL
260 join type is valid, e.g. C<LEFT> or C<RIGHT>. It will be placed in the SQL
261 command immediately before C<JOIN>.
263 =item proxy =E<gt> $column | \@columns | \%column
265 The 'proxy' attribute can be used to retrieve values, and to perform
266 updates if the relationship has 'cascade_update' set. The 'might_have'
267 and 'has_one' relationships have this set by default; if you want a proxy
268 to update across a 'belongs_to' relationship, you must set the attribute
275 An arrayref containing a list of accessors in the foreign class to create in
276 the main class. If, for example, you do the following:
278 MyApp::Schema::CD->might_have(liner_notes => 'MyApp::Schema::LinerNotes',
280 proxy => [ qw/notes/ ],
283 Then, assuming MyApp::Schema::LinerNotes has an accessor named notes, you can do:
285 my $cd = MyApp::Schema::CD->find(1);
286 $cd->notes('Notes go here'); # set notes -- LinerNotes object is
287 # created if it doesn't exist
289 For a 'belongs_to relationship, note the 'cascade_update':
291 MyApp::Schema::Track->belongs_to( cd => 'MyApp::Schema::CD', 'cd,
292 { proxy => ['title'], cascade_update => 1 }
294 $track->title('New Title');
295 $track->update; # updates title in CD
299 A hashref where each key is the accessor you want installed in the main class,
300 and its value is the name of the original in the foreign class.
302 MyApp::Schema::Track->belongs_to( cd => 'MyApp::Schema::CD', 'cd', {
303 proxy => { cd_title => 'title' },
306 This will create an accessor named C<cd_title> on the C<$track> result object.
310 NOTE: you can pass a nested struct too, for example:
312 MyApp::Schema::Track->belongs_to( cd => 'MyApp::Schema::CD', 'cd', {
313 proxy => [ 'year', { cd_title => 'title' } ],
318 Specifies the type of accessor that should be created for the relationship.
319 Valid values are C<single> (for when there is only a single related object),
320 C<multi> (when there can be many), and C<filter> (for when there is a single
321 related object, but you also want the relationship accessor to double as
322 a column accessor). For C<multi> accessors, an add_to_* method is also
323 created, which calls C<create_related> for the relationship.
325 =item is_foreign_key_constraint
327 If you are using L<SQL::Translator> to create SQL for you and you find that it
328 is creating constraints where it shouldn't, or not creating them where it
329 should, set this attribute to a true or false value to override the detection
330 of when to create constraints.
334 If C<cascade_copy> is true on a C<has_many> relationship for an
335 object, then when you copy the object all the related objects will
336 be copied too. To turn this behaviour off, pass C<< cascade_copy => 0 >>
337 in the C<$attr> hashref.
339 The behaviour defaults to C<< cascade_copy => 1 >> for C<has_many>
344 By default, DBIx::Class cascades deletes across C<has_many>,
345 C<has_one> and C<might_have> relationships. You can disable this
346 behaviour on a per-relationship basis by supplying
347 C<< cascade_delete => 0 >> in the relationship attributes.
349 The cascaded operations are performed after the requested delete,
350 so if your database has a constraint on the relationship, it will
351 have deleted/updated the related records or raised an exception
352 before DBIx::Class gets to perform the cascaded operation.
356 By default, DBIx::Class cascades updates across C<has_one> and
357 C<might_have> relationships. You can disable this behaviour on a
358 per-relationship basis by supplying C<< cascade_update => 0 >> in
359 the relationship attributes.
361 The C<belongs_to> relationship does not update across relationships
362 by default, so if you have a 'proxy' attribute on a belongs_to and want to
363 use 'update' on it, you muse set C<< cascade_update => 1 >>.
365 This is not a RDMS style cascade update - it purely means that when
366 an object has update called on it, all the related objects also
367 have update called. It will not change foreign keys automatically -
368 you must arrange to do this yourself.
370 =item on_delete / on_update
372 If you are using L<SQL::Translator> to create SQL for you, you can use these
373 attributes to explicitly set the desired C<ON DELETE> or C<ON UPDATE> constraint
374 type. If not supplied the SQLT parser will attempt to infer the constraint type by
375 interrogating the attributes of the B<opposite> relationship. For any 'multi'
376 relationship with C<< cascade_delete => 1 >>, the corresponding belongs_to
377 relationship will be created with an C<ON DELETE CASCADE> constraint. For any
378 relationship bearing C<< cascade_copy => 1 >> the resulting belongs_to constraint
379 will be C<ON UPDATE CASCADE>. If you wish to disable this autodetection, and just
380 use the RDBMS' default constraint type, pass C<< on_delete => undef >> or
381 C<< on_delete => '' >>, and the same for C<on_update> respectively.
385 Tells L<SQL::Translator> that the foreign key constraint it creates should be
386 deferrable. In other words, the user may request that the constraint be ignored
387 until the end of the transaction. Currently, only the PostgreSQL producer
388 actually supports this.
392 Tells L<SQL::Translator> to add an index for this constraint. Can also be
393 specified globally in the args to L<DBIx::Class::Schema/deploy> or
394 L<DBIx::Class::Schema/create_ddl_dir>. Default is on, set to 0 to disable.
398 =head2 register_relationship
402 =item Arguments: $rel_name, $rel_info
406 Registers a relationship on the class. This is called internally by
407 DBIx::Class::ResultSourceProxy to set up Accessors and Proxies.
411 sub register_relationship { }
413 =head2 related_resultset
417 =item Arguments: $rel_name
419 =item Return Value: L<$related_resultset|DBIx::Class::ResultSet>
423 $rs = $cd->related_resultset('artist');
425 Returns a L<DBIx::Class::ResultSet> for the relationship named
428 =head2 $relationship_accessor
432 =item Arguments: none
434 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | L<$related_resultset|DBIx::Class::ResultSet> | undef
438 # These pairs do the same thing
439 $result = $cd->related_resultset('artist')->single; # has_one relationship
440 $result = $cd->artist;
441 $rs = $cd->related_resultset('tracks'); # has_many relationship
444 This is the recommended way to traverse through relationships, based
445 on the L</accessor> name given in the relationship definition.
447 This will return either a L<Result|DBIx::Class::Manual::ResultClass> or a
448 L<ResultSet|DBIx::Class::ResultSet>, depending on if the relationship is
449 C<single> (returns only one row) or C<multi> (returns many rows). The
450 method may also return C<undef> if the relationship doesn't exist for
451 this instance (like in the case of C<might_have> relationships).
455 sub related_resultset {
458 $self->throw_exception("Can't call *_related as class methods")
463 return $self->{related_resultsets}{$rel}
464 if defined $self->{related_resultsets}{$rel};
466 return $self->{related_resultsets}{$rel} = do {
468 my $rel_info = $self->relationship_info($rel)
469 or $self->throw_exception( "No such relationship '$rel'" );
471 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
472 $attrs = { %{$rel_info->{attrs} || {}}, %$attrs };
474 $self->throw_exception( "Invalid query: @_" )
475 if (@_ > 1 && (@_ % 2 == 1));
476 my $query = ((@_ > 1) ? {@_} : shift);
478 my $rsrc = $self->result_source;
480 # condition resolution may fail if an incomplete master-object prefetch
481 # is encountered - that is ok during prefetch construction (not yet in_storage)
482 my ($cond, $is_crosstable) = try {
483 $rsrc->_resolve_condition( $rel_info->{cond}, $rel, $self, $rel )
486 $self->throw_exception ($_) if $self->in_storage;
487 $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION; # RV, no return()
490 # keep in mind that the following if() block is part of a do{} - no return()s!!!
491 if ($is_crosstable and ref $rel_info->{cond} eq 'CODE') {
493 # A WHOREIFFIC hack to reinvoke the entire condition resolution
494 # with the correct alias. Another way of doing this involves a
495 # lot of state passing around, and the @_ positions are already
496 # mapped out, making this crap a less icky option.
498 # The point of this exercise is to retain the spirit of the original
499 # $obj->search_related($rel) where the resulting rset will have the
500 # root alias as 'me', instead of $rel (as opposed to invoking
501 # $rs->search_related)
503 local $rsrc->{_relationships}{me} = $rsrc->{_relationships}{$rel}; # make the fake 'me' rel
504 my $obj_table_alias = lc($rsrc->source_name) . '__row';
505 $obj_table_alias =~ s/\W+/_/g;
507 $rsrc->resultset->search(
508 $self->ident_condition($obj_table_alias),
509 { alias => $obj_table_alias },
510 )->search_related('me', $query, $attrs)
513 # FIXME - this conditional doesn't seem correct - got to figure out
514 # at some point what it does. Also the entire UNRESOLVABLE_CONDITION
515 # business seems shady - we could simply not query *at all*
516 if ($cond eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
517 my $reverse = $rsrc->reverse_relationship_info($rel);
518 foreach my $rev_rel (keys %$reverse) {
519 if ($reverse->{$rev_rel}{attrs}{accessor} && $reverse->{$rev_rel}{attrs}{accessor} eq 'multi') {
520 weaken($attrs->{related_objects}{$rev_rel}[0] = $self);
522 weaken($attrs->{related_objects}{$rev_rel} = $self);
526 elsif (ref $cond eq 'ARRAY') {
528 if (ref $_ eq 'HASH') {
530 foreach my $key (keys %$_) {
531 my $newkey = $key !~ /\./ ? "me.$key" : $key;
532 $hash->{$newkey} = $_->{$key};
540 elsif (ref $cond eq 'HASH') {
541 foreach my $key (grep { ! /\./ } keys %$cond) {
542 $cond->{"me.$key"} = delete $cond->{$key};
546 $query = ($query ? { '-and' => [ $cond, $query ] } : $cond);
547 $rsrc->related_source($rel)->resultset->search(
554 =head2 search_related
558 =item Arguments: $rel_name, $cond?, L<\%attrs?|DBIx::Class::ResultSet/ATTRIBUTES>
560 =item Return Value: L<$resultset|DBIx::Class::ResultSet> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
564 Run a search on a related resultset. The search will be restricted to the
565 results represented by the L<DBIx::Class::ResultSet> it was called
568 See L<DBIx::Class::ResultSet/search_related> for more information.
573 return shift->related_resultset(shift)->search(@_);
576 =head2 search_related_rs
578 This method works exactly the same as search_related, except that
579 it guarantees a resultset, even in list context.
583 sub search_related_rs {
584 return shift->related_resultset(shift)->search_rs(@_);
591 =item Arguments: $rel_name, $cond?, L<\%attrs?|DBIx::Class::ResultSet/ATTRIBUTES>
593 =item Return Value: $count
597 Returns the count of all the rows in the related resultset, restricted by the
598 current result or where conditions.
603 shift->search_related(@_)->count;
610 =item Arguments: $rel_name, \%col_data
612 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
616 Create a new result object of the related foreign class. It will magically set
617 any foreign key columns of the new object to the related primary key columns
618 of the source object for you. The newly created result will not be saved into
619 your storage until you call L<DBIx::Class::Row/insert> on it.
624 my ($self, $rel, $values) = @_;
626 # FIXME - this is a bad position for this (also an identical copy in
627 # set_from_related), but I have no saner way to hook, and I absolutely
628 # want this to throw at least for coderefs, instead of the "insert a NULL
629 # when it gets hard" insanity --ribasushi
631 # sanity check - currently throw when a complex coderef rel is encountered
632 # FIXME - should THROW MOAR!
634 if (ref $self) { # cdbi calls this as a class method, /me vomits
636 my $rsrc = $self->result_source;
637 my $rel_info = $rsrc->relationship_info($rel)
638 or $self->throw_exception( "No such relationship '$rel'" );
639 my (undef, $crosstable, $nonequality_foreign_columns) = $rsrc->_resolve_condition (
640 $rel_info->{cond}, $rel, $self, $rel
643 $self->throw_exception("Relationship '$rel' does not resolve to a join-free condition fragment")
647 $nonequality_foreign_columns
649 my @unspecified_rel_condition_chunks = grep { ! exists $values->{$_} } @$nonequality_foreign_columns
651 $self->throw_exception(sprintf (
652 "Custom relationship '%s' not definitive - returns conditions instead of values for column(s): %s",
654 map { "'$_'" } @unspecified_rel_condition_chunks
659 return $self->search_related($rel)->new_result($values);
662 =head2 create_related
666 =item Arguments: $rel_name, \%col_data
668 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
672 my $result = $obj->create_related($rel_name, \%col_data);
674 Creates a new result object, similarly to new_related, and also inserts the
675 result's data into your storage medium. See the distinction between C<create>
676 and C<new> in L<DBIx::Class::ResultSet> for details.
683 my $obj = $self->new_related($rel, @_)->insert;
684 delete $self->{related_resultsets}->{$rel};
692 =item Arguments: $rel_name, \%col_data | @pk_values, { key => $unique_constraint, L<%attrs|DBIx::Class::ResultSet/ATTRIBUTES> }?
694 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
698 my $result = $obj->find_related($rel_name, \%col_data);
700 Attempt to find a related object using its primary key or unique constraints.
701 See L<DBIx::Class::ResultSet/find> for details.
706 #my ($self, $rel, @args) = @_;
707 return shift->search_related(shift)->find(@_);
710 =head2 find_or_new_related
714 =item Arguments: $rel_name, \%col_data, { key => $unique_constraint, L<%attrs|DBIx::Class::ResultSet/ATTRIBUTES> }?
716 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
720 Find a result object of a related class. See L<DBIx::Class::ResultSet/find_or_new>
725 sub find_or_new_related {
727 my $obj = $self->find_related(@_);
728 return defined $obj ? $obj : $self->new_related(@_);
731 =head2 find_or_create_related
735 =item Arguments: $rel_name, \%col_data, { key => $unique_constraint, L<%attrs|DBIx::Class::ResultSet/ATTRIBUTES> }?
737 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
741 Find or create a result object of a related class. See
742 L<DBIx::Class::ResultSet/find_or_create> for details.
746 sub find_or_create_related {
748 my $obj = $self->find_related(@_);
749 return (defined($obj) ? $obj : $self->create_related(@_));
752 =head2 update_or_create_related
756 =item Arguments: $rel_name, \%col_data, { key => $unique_constraint, L<%attrs|DBIx::Class::ResultSet/ATTRIBUTES> }?
758 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
762 Update or create a result object of a related class. See
763 L<DBIx::Class::ResultSet/update_or_create> for details.
767 sub update_or_create_related {
768 #my ($self, $rel, @args) = @_;
769 shift->related_resultset(shift)->update_or_create(@_);
772 =head2 set_from_related
776 =item Arguments: $rel_name, L<$result|DBIx::Class::Manual::ResultClass>
778 =item Return Value: not defined
782 $book->set_from_related('author', $author_obj);
783 $book->author($author_obj); ## same thing
785 Set column values on the current object, using related values from the given
786 related object. This is used to associate previously separate objects, for
787 example, to set the correct author for a book, find the Author object, then
788 call set_from_related on the book.
790 This is called internally when you pass existing objects as values to
791 L<DBIx::Class::ResultSet/create>, or pass an object to a belongs_to accessor.
793 The columns are only set in the local copy of the object, call L</update> to
794 set them in the storage.
798 sub set_from_related {
799 my ($self, $rel, $f_obj) = @_;
801 my $rsrc = $self->result_source;
802 my $rel_info = $rsrc->relationship_info($rel)
803 or $self->throw_exception( "No such relationship '$rel'" );
805 if (defined $f_obj) {
806 my $f_class = $rel_info->{class};
807 $self->throw_exception( "Object '$f_obj' isn't a ".$f_class )
808 unless blessed $f_obj and $f_obj->isa($f_class);
812 # FIXME - this is a bad position for this (also an identical copy in
813 # new_related), but I have no saner way to hook, and I absolutely
814 # want this to throw at least for coderefs, instead of the "insert a NULL
815 # when it gets hard" insanity --ribasushi
817 # sanity check - currently throw when a complex coderef rel is encountered
818 # FIXME - should THROW MOAR!
819 my ($cond, $crosstable, $nonequality_foreign_columns) = $rsrc->_resolve_condition (
820 $rel_info->{cond}, $f_obj, $rel, $rel
822 $self->throw_exception("Relationship '$rel' does not resolve to a join-free condition fragment")
825 $self->throw_exception(sprintf (
826 "Custom relationship '%s' not definitive - returns conditions instead of values for column(s): %s",
828 map { "'$_'" } @$nonequality_foreign_columns
829 )) if $nonequality_foreign_columns;
831 $self->set_columns($cond);
836 =head2 update_from_related
840 =item Arguments: $rel_name, L<$result|DBIx::Class::Manual::ResultClass>
842 =item Return Value: not defined
846 $book->update_from_related('author', $author_obj);
848 The same as L</"set_from_related">, but the changes are immediately updated
853 sub update_from_related {
855 $self->set_from_related(@_);
859 =head2 delete_related
863 =item Arguments: $rel_name, $cond?, L<\%attrs?|DBIx::Class::ResultSet/ATTRIBUTES>
865 =item Return Value: $underlying_storage_rv
869 Delete any related row, subject to the given conditions. Internally, this
872 $self->search_related(@_)->delete
874 And returns the result of that.
880 my $obj = $self->search_related(@_)->delete;
881 delete $self->{related_resultsets}->{$_[0]};
887 B<Currently only available for C<has_many>, C<many_to_many> and 'multi' type
890 =head3 has_many / multi
894 =item Arguments: \%col_data
896 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
900 Creates/inserts a new result object. Internally, this calls:
902 $self->create_related($rel, @_)
904 And returns the result of that.
910 =item Arguments: (\%col_data | L<$result|DBIx::Class::Manual::ResultClass>), \%link_col_data?
912 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
916 my $role = $schema->resultset('Role')->find(1);
917 $actor->add_to_roles($role);
918 # creates a My::DBIC::Schema::ActorRoles linking table result object
920 $actor->add_to_roles({ name => 'lead' }, { salary => 15_000_000 });
921 # creates a new My::DBIC::Schema::Role result object and the linking table
922 # object with an extra column in the link
924 Adds a linking table object. If the first argument is a hash reference, the
925 related object is created first with the column values in the hash. If an object
926 reference is given, just the linking table object is created. In either case,
927 any additional column values for the linking table object can be specified in
930 See L<DBIx::Class::Relationship/many_to_many> for additional details.
934 B<Currently only available for C<many_to_many> relationships.>
938 =item Arguments: (\@hashrefs_of_col_data | L<\@result_objs|DBIx::Class::Manual::ResultClass>), $link_vals?
940 =item Return Value: not defined
944 my $actor = $schema->resultset('Actor')->find(1);
945 my @roles = $schema->resultset('Role')->search({ role =>
946 { '-in' => ['Fred', 'Barney'] } } );
948 $actor->set_roles(\@roles);
949 # Replaces all of $actor's previous roles with the two named
951 $actor->set_roles(\@roles, { salary => 15_000_000 });
952 # Sets a column in the link table for all roles
955 Replace all the related objects with the given reference to a list of
956 objects. This does a C<delete> B<on the link table resultset> to remove the
957 association between the current object and all related objects, then calls
958 C<add_to_$rel> repeatedly to link all the new objects.
960 Note that this means that this method will B<not> delete any objects in the
961 table on the right side of the relation, merely that it will delete the link
964 Due to a mistake in the original implementation of this method, it will also
965 accept a list of objects or hash references. This is B<deprecated> and will be
966 removed in a future version.
968 =head2 remove_from_$rel
970 B<Currently only available for C<many_to_many> relationships.>
974 =item Arguments: L<$result|DBIx::Class::Manual::ResultClass>
976 =item Return Value: not defined
980 my $role = $schema->resultset('Role')->find(1);
981 $actor->remove_from_roles($role);
982 # removes $role's My::DBIC::Schema::ActorRoles linking table result object
984 Removes the link between the current object and the related object. Note that
985 the related object itself won't be deleted unless you call ->delete() on
986 it. This method just removes the link between the two objects.
988 =head1 AUTHOR AND CONTRIBUTORS
990 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
994 You may distribute this code under the same terms as Perl itself.