lib/DBIx/Class/Relationship/Base.pm

   1 package DBIx::Class::Relationship::Base;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base qw/DBIx::Class/;
   7
   8 use Scalar::Util qw/weaken blessed/;
   9 use Try::Tiny;
  10 use namespace::clean;
  11
  12 =head1 NAME
  13
  14 DBIx::Class::Relationship::Base - Inter-table relationships
  15
  16 =head1 SYNOPSIS
  17
  18   __PACKAGE__->add_relationship(
  19     spiders => 'My::DB::Result::Creatures',
  20     sub {
  21       my $args = shift;
  22       return {
  23         "$args->{foreign_alias}.id"   => { -ident => "$args->{self_alias}.id" },
  24         "$args->{foreign_alias}.type" => 'arachnid'
  25       };
  26     },
  27   );
  28
  29 =head1 DESCRIPTION
  30
  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>.
  34
  35 =head1 METHODS
  36
  37 =head2 add_relationship
  38
  39 =over 4
  40
  41 =item Arguments: 'relname', 'Foreign::Class', $condition, $attrs
  42
  43 =back
  44
  45   __PACKAGE__->add_relationship('relname',
  46                                 'Foreign::Class',
  47                                 $condition, $attrs);
  48
  49 Create a custom relationship between one result source and another
  50 source, indicated by its class name.
  51
  52 =head3 condition
  53
  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.
  56
  57 To create simple equality joins, supply a hashref containing the
  58 remote table column name as the key(s), and the local table column
  59 name as the value(s), for example given:
  60
  61   My::Schema::Author->has_many(
  62     books => 'My::Schema::Book',
  63     { 'foreign.author_id' => 'self.id' }
  64   );
  65
  66 A query like:
  67
  68   $author_rs->search_related('books')->next
  69
  70 will result in the following C<JOIN> clause:
  71
  72   ... FROM author me LEFT JOIN book books ON books.author_id = me.id ...
  73
  74 This describes a relationship between the C<Author> table and the
  75 C<Book> table where the C<Book> table has a column C<author_id>
  76 containing the ID value of the C<Author>.
  77
  78 C<foreign> and C<self> are pseudo aliases and must be entered
  79 literally. They will be replaced with the actual correct table alias
  80 when the SQL is produced.
  81
  82 Similarly:
  83
  84   My::Schema::Book->has_many(
  85     editions => 'My::Schema::Edition',
  86     {
  87       'foreign.publisher_id' => 'self.publisher_id',
  88       'foreign.type_id'      => 'self.type_id',
  89     }
  90   );
  91
  92   ...
  93
  94   $book_rs->search_related('editions')->next
  95
  96 will result in the C<JOIN> clause:
  97
  98   ... FROM book me
  99       LEFT JOIN edition editions ON
 100            editions.publisher_id = me.publisher_id
 101        AND editions.type_id = me.type_id ...
 102
 103 This describes the relationship from C<Book> to C<Edition>, where the
 104 C<Edition> table refers to a publisher and a type (e.g. "paperback"):
 105
 106 As is the default in L<SQL::Abstract>, the key-value pairs will be
 107 C<AND>ed in the result. C<OR> can be achieved with an arrayref, for
 108 example a condition like:
 109
 110   My::Schema::Item->has_many(
 111     related_item_links => My::Schema::Item::Links,
 112     [
 113       { 'foreign.left_itemid'  => 'self.id' },
 114       { 'foreign.right_itemid' => 'self.id' },
 115     ],
 116   );
 117
 118 will translate to the following C<JOIN> clause:
 119
 120  ... FROM item me JOIN item_relations related_item_links ON
 121          related_item_links.left_itemid = me.id
 122       OR related_item_links.right_itemid = me.id ...
 123
 124 This describes the relationship from C<Item> to C<Item::Links>, where
 125 C<Item::Links> is a many-to-many linking table, linking items back to
 126 themselves in a peer fashion (without a "parent-child" designation)
 127
 128 To specify joins which describe more than a simple equality of column
 129 values, the custom join condition coderef syntax can be used. For
 130 example:
 131
 132   My::Schema::Artist->has_many(
 133     cds_80s => 'My::Schema::CD',
 134     sub {
 135       my $args = shift;
 136
 137       return {
 138         "$args->{foreign_alias}.artist" => { -ident => "$args->{self_alias}.artistid" },
 139         "$args->{foreign_alias}.year"   => { '>', "1979", '<', "1990" },
 140       };
 141     }
 142   );
 143
 144   ...
 145
 146   $artist_rs->search_related('cds_80s')->next;
 147
 148 will result in the C<JOIN> clause:
 149
 150   ... FROM artist me LEFT JOIN cd cds_80s ON
 151         cds_80s.artist = me.artistid
 152     AND cds_80s.year < ?
 153     AND cds_80s.year > ?
 154
 155 with the bind values:
 156
 157    '1990', '1979'
 158
 159 C<< $args->{foreign_alias} >> and C<< $args->{self_alias} >> are supplied the
 160 same values that would be otherwise substituted for C<foreign> and C<self>
 161 in the simple hashref syntax case.
 162
 163 The coderef is expected to return a valid L<SQL::Abstract> query-structure, just
 164 like what one would supply as the first argument to
 165 L<DBIx::Class::ResultSet/search>. The return value will be passed directly to
 166 L<SQL::Abstract> and the resulting SQL will be used verbatim as the C<ON>
 167 clause of the C<JOIN> statement associated with this relationship.
 168
 169 While every coderef-based condition must return a valid C<ON> clause, it may
 170 elect to additionally return a simplified join-free condition hashref when
 171 invoked as C<< $result->relationship >>, as opposed to
 172 C<< $rs->related_resultset('relationship') >>. In this case C<$result> is
 173 passed to the coderef as C<< $args->{self_rowobj} >>, so a user can do the
 174 following:
 175
 176   sub {
 177     my $args = shift;
 178
 179     return (
 180       {
 181         "$args->{foreign_alias}.artist" => { -ident => "$args->{self_alias}.artistid" },
 182         "$args->{foreign_alias}.year"   => { '>', "1979", '<', "1990" },
 183       },
 184       $args->{self_rowobj} && {
 185         "$args->{foreign_alias}.artist" => $args->{self_rowobj}->artistid,
 186         "$args->{foreign_alias}.year"   => { '>', "1979", '<', "1990" },
 187       },
 188     );
 189   }
 190
 191 Now this code:
 192
 193     my $artist = $schema->resultset("Artist")->find({ id => 4 });
 194     $artist->cds_80s->all;
 195
 196 Can skip a C<JOIN> altogether and instead produce:
 197
 198     SELECT cds_80s.cdid, cds_80s.artist, cds_80s.title, cds_80s.year, cds_80s.genreid, cds_80s.single_track
 199       FROM cd cds_80s
 200       WHERE cds_80s.artist = ?
 201         AND cds_80s.year < ?
 202         AND cds_80s.year > ?
 203
 204 With the bind values:
 205
 206     '4', '1990', '1979'
 207
 208 Note that in order to be able to use
 209 L<< $row->create_related|DBIx::Class::Relationship::Base/create_related >>,
 210 the coderef must not only return as its second such a "simple" condition
 211 hashref which does not depend on joins being available, but the hashref must
 212 contain only plain values/deflatable objects, such that the result can be
 213 passed directly to L<DBIx::Class::Relationship::Base/set_from_related>. For
 214 instance the C<year> constraint in the above example prevents the relationship
 215 from being used to to create related objects (an exception will be thrown).
 216
 217 In order to allow the user to go truly crazy when generating a custom C<ON>
 218 clause, the C<$args> hashref passed to the subroutine contains some extra
 219 metadata. Currently the supplied coderef is executed as:
 220
 221   $relationship_info->{cond}->({
 222     self_alias        => The alias of the invoking resultset ('me' in case of a result object),
 223     foreign_alias     => The alias of the to-be-joined resultset (often matches relname),
 224     self_resultsource => The invocant's resultsource,
 225     foreign_relname   => The relationship name (does *not* always match foreign_alias),
 226     self_rowobj       => The invocant itself in case of a $result_object->$relationship call
 227   });
 228
 229 =head3 attributes
 230
 231 The L<standard ResultSet attributes|DBIx::Class::ResultSet/ATTRIBUTES> may
 232 be used as relationship attributes. In particular, the 'where' attribute is
 233 useful for filtering relationships:
 234
 235      __PACKAGE__->has_many( 'valid_users', 'MyApp::Schema::User',
 236         { 'foreign.user_id' => 'self.user_id' },
 237         { where => { valid => 1 } }
 238     );
 239
 240 The following attributes are also valid:
 241
 242 =over 4
 243
 244 =item join_type
 245
 246 Explicitly specifies the type of join to use in the relationship. Any SQL
 247 join type is valid, e.g. C<LEFT> or C<RIGHT>. It will be placed in the SQL
 248 command immediately before C<JOIN>.
 249
 250 =item proxy =E<gt> $column | \@columns | \%column
 251
 252 The 'proxy' attribute can be used to retrieve values, and to perform
 253 updates if the relationship has 'cascade_update' set. The 'might_have'
 254 and 'has_one' relationships have this set by default; if you want a proxy
 255 to update across a 'belongs_to' relationship, you must set the attribute
 256 yourself.
 257
 258 =over 4
 259
 260 =item \@columns
 261
 262 An arrayref containing a list of accessors in the foreign class to create in
 263 the main class. If, for example, you do the following:
 264
 265   MyApp::Schema::CD->might_have(liner_notes => 'MyApp::Schema::LinerNotes',
 266     undef, {
 267       proxy => [ qw/notes/ ],
 268     });
 269
 270 Then, assuming MyApp::Schema::LinerNotes has an accessor named notes, you can do:
 271
 272   my $cd = MyApp::Schema::CD->find(1);
 273   $cd->notes('Notes go here'); # set notes -- LinerNotes object is
 274                                # created if it doesn't exist
 275
 276 For a 'belongs_to relationship, note the 'cascade_update':
 277
 278   MyApp::Schema::Track->belongs_to( cd => 'DBICTest::Schema::CD', 'cd,
 279       { proxy => ['title'], cascade_update => 1 }
 280   );
 281   $track->title('New Title');
 282   $track->update; # updates title in CD
 283
 284 =item \%column
 285
 286 A hashref where each key is the accessor you want installed in the main class,
 287 and its value is the name of the original in the fireign class.
 288
 289   MyApp::Schema::Track->belongs_to( cd => 'DBICTest::Schema::CD', 'cd', {
 290       proxy => { cd_title => 'title' },
 291   });
 292
 293 This will create an accessor named C<cd_title> on the C<$track> result object.
 294
 295 =back
 296
 297 NOTE: you can pass a nested struct too, for example:
 298
 299   MyApp::Schema::Track->belongs_to( cd => 'DBICTest::Schema::CD', 'cd', {
 300     proxy => [ 'year', { cd_title => 'title' } ],
 301   });
 302
 303 =item accessor
 304
 305 Specifies the type of accessor that should be created for the relationship.
 306 Valid values are C<single> (for when there is only a single related object),
 307 C<multi> (when there can be many), and C<filter> (for when there is a single
 308 related object, but you also want the relationship accessor to double as
 309 a column accessor). For C<multi> accessors, an add_to_* method is also
 310 created, which calls C<create_related> for the relationship.
 311
 312 =item is_foreign_key_constraint
 313
 314 If you are using L<SQL::Translator> to create SQL for you and you find that it
 315 is creating constraints where it shouldn't, or not creating them where it
 316 should, set this attribute to a true or false value to override the detection
 317 of when to create constraints.
 318
 319 =item cascade_copy
 320
 321 If C<cascade_copy> is true on a C<has_many> relationship for an
 322 object, then when you copy the object all the related objects will
 323 be copied too. To turn this behaviour off, pass C<< cascade_copy => 0 >>
 324 in the C<$attr> hashref.
 325
 326 The behaviour defaults to C<< cascade_copy => 1 >> for C<has_many>
 327 relationships.
 328
 329 =item cascade_delete
 330
 331 By default, DBIx::Class cascades deletes across C<has_many>,
 332 C<has_one> and C<might_have> relationships. You can disable this
 333 behaviour on a per-relationship basis by supplying
 334 C<< cascade_delete => 0 >> in the relationship attributes.
 335
 336 The cascaded operations are performed after the requested delete,
 337 so if your database has a constraint on the relationship, it will
 338 have deleted/updated the related records or raised an exception
 339 before DBIx::Class gets to perform the cascaded operation.
 340
 341 =item cascade_update
 342
 343 By default, DBIx::Class cascades updates across C<has_one> and
 344 C<might_have> relationships. You can disable this behaviour on a
 345 per-relationship basis by supplying C<< cascade_update => 0 >> in
 346 the relationship attributes.
 347
 348 The C<belongs_to> relationship does not update across relationships
 349 by default, so if you have a 'proxy' attribute on a belongs_to and want to
 350 use 'update' on it, you muse set C<< cascade_update => 1 >>.
 351
 352 This is not a RDMS style cascade update - it purely means that when
 353 an object has update called on it, all the related objects also
 354 have update called. It will not change foreign keys automatically -
 355 you must arrange to do this yourself.
 356
 357 =item on_delete / on_update
 358
 359 If you are using L<SQL::Translator> to create SQL for you, you can use these
 360 attributes to explicitly set the desired C<ON DELETE> or C<ON UPDATE> constraint
 361 type. If not supplied the SQLT parser will attempt to infer the constraint type by
 362 interrogating the attributes of the B<opposite> relationship. For any 'multi'
 363 relationship with C<< cascade_delete => 1 >>, the corresponding belongs_to
 364 relationship will be created with an C<ON DELETE CASCADE> constraint. For any
 365 relationship bearing C<< cascade_copy => 1 >> the resulting belongs_to constraint
 366 will be C<ON UPDATE CASCADE>. If you wish to disable this autodetection, and just
 367 use the RDBMS' default constraint type, pass C<< on_delete => undef >> or
 368 C<< on_delete => '' >>, and the same for C<on_update> respectively.
 369
 370 =item is_deferrable
 371
 372 Tells L<SQL::Translator> that the foreign key constraint it creates should be
 373 deferrable. In other words, the user may request that the constraint be ignored
 374 until the end of the transaction. Currently, only the PostgreSQL producer
 375 actually supports this.
 376
 377 =item add_fk_index
 378
 379 Tells L<SQL::Translator> to add an index for this constraint. Can also be
 380 specified globally in the args to L<DBIx::Class::Schema/deploy> or
 381 L<DBIx::Class::Schema/create_ddl_dir>. Default is on, set to 0 to disable.
 382
 383 =back
 384
 385 =head2 register_relationship
 386
 387 =over 4
 388
 389 =item Arguments: $rel_name, $rel_info
 390
 391 =back
 392
 393 Registers a relationship on the class. This is called internally by
 394 DBIx::Class::ResultSourceProxy to set up Accessors and Proxies.
 395
 396 =cut
 397
 398 sub register_relationship { }
 399
 400 =head2 related_resultset
 401
 402 =over 4
 403
 404 =item Arguments: $rel_name
 405
 406 =item Return Value: L<$related_resultset|DBIx::Class::ResultSet>
 407
 408 =back
 409
 410   $rs = $cd->related_resultset('artist');
 411
 412 Returns a L<DBIx::Class::ResultSet> for the relationship named
 413 $rel_name.
 414
 415 =head2 $relationship_accessor
 416
 417 =over 4
 418
 419 =item Arguments: none
 420
 421 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | L<$related_resultset|DBIx::Class::ResultSet> | undef
 422
 423 =back
 424
 425   # These pairs do the same thing
 426   $row = $cd->related_resultset('artist')->single;  # has_one relationship
 427   $row = $cd->artist;
 428   $rs = $cd->related_resultset('tracks');           # has_many relationship
 429   $rs = $cd->tracks;
 430
 431 This is the recommended way to traverse through relationships, based
 432 on the L</accessor> name given in the relationship definition.
 433
 434 This will return either a L<Result|DBIx::Class::Manual::ResultClass> or a
 435 L<ResultSet|DBIx::Class::ResultSet>, depending on if the relationship is
 436 C<single> (returns only one row) or C<multi> (returns many rows).  The
 437 method may also return C<undef> if the relationship doesn't exist for
 438 this instance (like in the case of C<might_have> relationships).
 439
 440 =cut
 441
 442 sub related_resultset {
 443   my $self = shift;
 444
 445   $self->throw_exception("Can't call *_related as class methods")
 446     unless ref $self;
 447
 448   my $rel = shift;
 449   my $rel_info = $self->relationship_info($rel);
 450   $self->throw_exception( "No such relationship '$rel'" )
 451     unless $rel_info;
 452
 453   return $self->{related_resultsets}{$rel} ||= do {
 454     my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
 455     $attrs = { %{$rel_info->{attrs} || {}}, %$attrs };
 456
 457     $self->throw_exception( "Invalid query: @_" )
 458       if (@_ > 1 && (@_ % 2 == 1));
 459     my $query = ((@_ > 1) ? {@_} : shift);
 460
 461     my $rsrc = $self->result_source;
 462
 463     # condition resolution may fail if an incomplete master-object prefetch
 464     # is encountered - that is ok during prefetch construction (not yet in_storage)
 465     my ($cond, $is_crosstable) = try {
 466       $rsrc->_resolve_condition( $rel_info->{cond}, $rel, $self, $rel )
 467     }
 468     catch {
 469       if ($self->in_storage) {
 470         $self->throw_exception ($_);
 471       }
 472
 473       $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION;  # RV
 474     };
 475
 476     # keep in mind that the following if() block is part of a do{} - no return()s!!!
 477     if ($is_crosstable) {
 478       $self->throw_exception (
 479         "A cross-table relationship condition returned for statically declared '$rel'"
 480       ) unless ref $rel_info->{cond} eq 'CODE';
 481
 482       # A WHOREIFFIC hack to reinvoke the entire condition resolution
 483       # with the correct alias. Another way of doing this involves a
 484       # lot of state passing around, and the @_ positions are already
 485       # mapped out, making this crap a less icky option.
 486       #
 487       # The point of this exercise is to retain the spirit of the original
 488       # $obj->search_related($rel) where the resulting rset will have the
 489       # root alias as 'me', instead of $rel (as opposed to invoking
 490       # $rs->search_related)
 491
 492       local $rsrc->{_relationships}{me} = $rsrc->{_relationships}{$rel};  # make the fake 'me' rel
 493       my $obj_table_alias = lc($rsrc->source_name) . '__row';
 494       $obj_table_alias =~ s/\W+/_/g;
 495
 496       $rsrc->resultset->search(
 497         $self->ident_condition($obj_table_alias),
 498         { alias => $obj_table_alias },
 499       )->search_related('me', $query, $attrs)
 500     }
 501     else {
 502       # FIXME - this conditional doesn't seem correct - got to figure out
 503       # at some point what it does. Also the entire UNRESOLVABLE_CONDITION
 504       # business seems shady - we could simply not query *at all*
 505       if ($cond eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
 506         my $reverse = $rsrc->reverse_relationship_info($rel);
 507         foreach my $rev_rel (keys %$reverse) {
 508           if ($reverse->{$rev_rel}{attrs}{accessor} && $reverse->{$rev_rel}{attrs}{accessor} eq 'multi') {
 509             weaken($attrs->{related_objects}{$rev_rel}[0] = $self);
 510           } else {
 511             weaken($attrs->{related_objects}{$rev_rel} = $self);
 512           }
 513         }
 514       }
 515       elsif (ref $cond eq 'ARRAY') {
 516         $cond = [ map {
 517           if (ref $_ eq 'HASH') {
 518             my $hash;
 519             foreach my $key (keys %$_) {
 520               my $newkey = $key !~ /\./ ? "me.$key" : $key;
 521               $hash->{$newkey} = $_->{$key};
 522             }
 523             $hash;
 524           } else {
 525             $_;
 526           }
 527         } @$cond ];
 528       }
 529       elsif (ref $cond eq 'HASH') {
 530        foreach my $key (grep { ! /\./ } keys %$cond) {
 531           $cond->{"me.$key"} = delete $cond->{$key};
 532         }
 533       }
 534
 535       $query = ($query ? { '-and' => [ $cond, $query ] } : $cond);
 536       $rsrc->related_source($rel)->resultset->search(
 537         $query, $attrs
 538       );
 539     }
 540   };
 541 }
 542
 543 =head2 search_related
 544
 545 =over 4
 546
 547 =item Arguments: $rel_name, $cond?, L<\%attrs?|DBIx::Class::ResultSet/ATTRIBUTES>
 548
 549 =item Return Value: L<$resultset|DBIx::Class::ResultSet> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
 550
 551 =back
 552
 553 Run a search on a related resultset. The search will be restricted to the
 554 results represented by the L<DBIx::Class::ResultSet> it was called
 555 upon.
 556
 557 See L<DBIx::Class::ResultSet/search_related> for more information.
 558
 559 =cut
 560
 561 sub search_related {
 562   return shift->related_resultset(shift)->search(@_);
 563 }
 564
 565 =head2 search_related_rs
 566
 567 This method works exactly the same as search_related, except that
 568 it guarantees a resultset, even in list context.
 569
 570 =cut
 571
 572 sub search_related_rs {
 573   return shift->related_resultset(shift)->search_rs(@_);
 574 }
 575
 576 =head2 count_related
 577
 578 =over 4
 579
 580 =item Arguments: $rel_name, $cond?, L<\%attrs?|DBIx::Class::ResultSet/ATTRIBUTES>
 581
 582 =item Return Value: $count
 583
 584 =back
 585
 586 Returns the count of all the rows in the related resultset, restricted by the
 587 current result or where conditions.
 588
 589 =cut
 590
 591 sub count_related {
 592   shift->search_related(@_)->count;
 593 }
 594
 595 =head2 new_related
 596
 597 =over 4
 598
 599 =item Arguments: $rel_name, \%col_data
 600
 601 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
 602
 603 =back
 604
 605 Create a new result object of the related foreign class.  It will magically set
 606 any foreign key columns of the new object to the related primary key columns
 607 of the source object for you.  The newly created result will not be saved into
 608 your storage until you call L<DBIx::Class::Row/insert> on it.
 609
 610 =cut
 611
 612 sub new_related {
 613   my ($self, $rel, $values) = @_;
 614
 615   # FIXME - this is a bad position for this (also an identical copy in
 616   # set_from_related), but I have no saner way to hook, and I absolutely
 617   # want this to throw at least for coderefs, instead of the "insert a NULL
 618   # when it gets hard" insanity --ribasushi
 619   #
 620   # sanity check - currently throw when a complex coderef rel is encountered
 621   # FIXME - should THROW MOAR!
 622
 623   if (ref $self) {  # cdbi calls this as a class method, /me vomits
 624
 625     my $rsrc = $self->result_source;
 626     my (undef, $crosstable, $cond_targets) = $rsrc->_resolve_condition (
 627       $rsrc->relationship_info($rel)->{cond}, $rel, $self, $rel
 628     );
 629
 630     $self->throw_exception("Custom relationship '$rel' does not resolve to a join-free condition fragment")
 631       if $crosstable;
 632
 633     if (my @unspecified_rel_condition_chunks = grep { ! exists $values->{$_} } @{$cond_targets||[]} ) {
 634       $self->throw_exception(sprintf (
 635         "Custom relationship '%s' not definitive - returns conditions instead of values for column(s): %s",
 636         $rel,
 637         map { "'$_'" } @unspecified_rel_condition_chunks
 638       ));
 639     }
 640   }
 641
 642   return $self->search_related($rel)->new_result($values);
 643 }
 644
 645 =head2 create_related
 646
 647 =over 4
 648
 649 =item Arguments: $rel_name, \%col_data
 650
 651 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
 652
 653 =back
 654
 655   my $result = $obj->create_related($rel_name, \%col_data);
 656
 657 Creates a new result object, similarly to new_related, and also inserts the
 658 result's data into your storage medium. See the distinction between C<create>
 659 and C<new> in L<DBIx::Class::ResultSet> for details.
 660
 661 =cut
 662
 663 sub create_related {
 664   my $self = shift;
 665   my $rel = shift;
 666   my $obj = $self->new_related($rel, @_)->insert;
 667   delete $self->{related_resultsets}->{$rel};
 668   return $obj;
 669 }
 670
 671 =head2 find_related
 672
 673 =over 4
 674
 675 =item Arguments: $rel_name, \%col_data | @pk_values, { key => $unique_constraint, L<%attrs|DBIx::Class::ResultSet/ATTRIBUTES> }?
 676
 677 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
 678
 679 =back
 680
 681   my $result = $obj->find_related($rel_name, \%col_data);
 682
 683 Attempt to find a related object using its primary key or unique constraints.
 684 See L<DBIx::Class::ResultSet/find> for details.
 685
 686 =cut
 687
 688 sub find_related {
 689   #my ($self, $rel, @args) = @_;
 690   return shift->search_related(shift)->find(@_);
 691 }
 692
 693 =head2 find_or_new_related
 694
 695 =over 4
 696
 697 =item Arguments: $rel_name, \%col_data, { key => $unique_constraint, L<%attrs|DBIx::Class::ResultSet/ATTRIBUTES> }?
 698
 699 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
 700
 701 =back
 702
 703 Find a result object of a related class.  See L<DBIx::Class::ResultSet/find_or_new>
 704 for details.
 705
 706 =cut
 707
 708 sub find_or_new_related {
 709   my $self = shift;
 710   my $obj = $self->find_related(@_);
 711   return defined $obj ? $obj : $self->new_related(@_);
 712 }
 713
 714 =head2 find_or_create_related
 715
 716 =over 4
 717
 718 =item Arguments: $rel_name, \%col_data, { key => $unique_constraint, L<%attrs|DBIx::Class::ResultSet/ATTRIBUTES> }?
 719
 720 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
 721
 722 =back
 723
 724 Find or create a result object of a related class. See
 725 L<DBIx::Class::ResultSet/find_or_create> for details.
 726
 727 =cut
 728
 729 sub find_or_create_related {
 730   my $self = shift;
 731   my $obj = $self->find_related(@_);
 732   return (defined($obj) ? $obj : $self->create_related(@_));
 733 }
 734
 735 =head2 update_or_create_related
 736
 737 =over 4
 738
 739 =item Arguments: $rel_name, \%col_data, { key => $unique_constraint, L<%attrs|DBIx::Class::ResultSet/ATTRIBUTES> }?
 740
 741 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
 742
 743 =back
 744
 745 Update or create a result object of a related class. See
 746 L<DBIx::Class::ResultSet/update_or_create> for details.
 747
 748 =cut
 749
 750 sub update_or_create_related {
 751   #my ($self, $rel, @args) = @_;
 752   shift->related_resultset(shift)->update_or_create(@_);
 753 }
 754
 755 =head2 set_from_related
 756
 757 =over 4
 758
 759 =item Arguments: $rel_name, L<$result|DBIx::Class::Manual::ResultClass>
 760
 761 =item Return Value: not defined
 762
 763 =back
 764
 765   $book->set_from_related('author', $author_obj);
 766   $book->author($author_obj);                      ## same thing
 767
 768 Set column values on the current object, using related values from the given
 769 related object. This is used to associate previously separate objects, for
 770 example, to set the correct author for a book, find the Author object, then
 771 call set_from_related on the book.
 772
 773 This is called internally when you pass existing objects as values to
 774 L<DBIx::Class::ResultSet/create>, or pass an object to a belongs_to accessor.
 775
 776 The columns are only set in the local copy of the object, call L</update> to
 777 set them in the storage.
 778
 779 =cut
 780
 781 sub set_from_related {
 782   my ($self, $rel, $f_obj) = @_;
 783
 784   my $rsrc = $self->result_source;
 785   my $rel_info = $rsrc->relationship_info($rel)
 786     or $self->throw_exception( "No such relationship '$rel'" );
 787
 788   if (defined $f_obj) {
 789     my $f_class = $rel_info->{class};
 790     $self->throw_exception( "Object '$f_obj' isn't a ".$f_class )
 791       unless blessed $f_obj and $f_obj->isa($f_class);
 792   }
 793
 794
 795   # FIXME - this is a bad position for this (also an identical copy in
 796   # new_related), but I have no saner way to hook, and I absolutely
 797   # want this to throw at least for coderefs, instead of the "insert a NULL
 798   # when it gets hard" insanity --ribasushi
 799   #
 800   # sanity check - currently throw when a complex coderef rel is encountered
 801   # FIXME - should THROW MOAR!
 802   my ($cond, $crosstable, $cond_targets) = $rsrc->_resolve_condition (
 803     $rel_info->{cond}, $f_obj, $rel, $rel
 804   );
 805   $self->throw_exception("Custom relationship '$rel' does not resolve to a join-free condition fragment")
 806     if $crosstable;
 807   $self->throw_exception(sprintf (
 808     "Custom relationship '%s' not definitive - returns conditions instead of values for column(s): %s",
 809     $rel,
 810     map { "'$_'" } @$cond_targets
 811   )) if $cond_targets;
 812
 813   $self->set_columns($cond);
 814
 815   return 1;
 816 }
 817
 818 =head2 update_from_related
 819
 820 =over 4
 821
 822 =item Arguments: $rel_name, L<$result|DBIx::Class::Manual::ResultClass>
 823
 824 =item Return Value: not defined
 825
 826 =back
 827
 828   $book->update_from_related('author', $author_obj);
 829
 830 The same as L</"set_from_related">, but the changes are immediately updated
 831 in storage.
 832
 833 =cut
 834
 835 sub update_from_related {
 836   my $self = shift;
 837   $self->set_from_related(@_);
 838   $self->update;
 839 }
 840
 841 =head2 delete_related
 842
 843 =over 4
 844
 845 =item Arguments: $rel_name, $cond?, L<\%attrs?|DBIx::Class::ResultSet/ATTRIBUTES>
 846
 847 =item Return Value: $underlying_storage_rv
 848
 849 =back
 850
 851 Delete any related row, subject to the given conditions.  Internally, this
 852 calls:
 853
 854   $self->search_related(@_)->delete
 855
 856 And returns the result of that.
 857
 858 =cut
 859
 860 sub delete_related {
 861   my $self = shift;
 862   my $obj = $self->search_related(@_)->delete;
 863   delete $self->{related_resultsets}->{$_[0]};
 864   return $obj;
 865 }
 866
 867 =head2 add_to_$rel
 868
 869 B<Currently only available for C<has_many>, C<many_to_many> and 'multi' type
 870 relationships.>
 871
 872 =head3 has_many / multi
 873
 874 =over 4
 875
 876 =item Arguments: \%col_data
 877
 878 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
 879
 880 =back
 881
 882 Creates/inserts a new result object.  Internally, this calls:
 883
 884   $self->create_related($rel, @_)
 885
 886 And returns the result of that.
 887
 888 =head3 many_to_many
 889
 890 =over 4
 891
 892 =item Arguments: (\%col_data | L<$result|DBIx::Class::Manual::ResultClass>), \%link_col_data?
 893
 894 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
 895
 896 =back
 897
 898   my $role = $schema->resultset('Role')->find(1);
 899   $actor->add_to_roles($role);
 900       # creates a My::DBIC::Schema::ActorRoles linking table result object
 901
 902   $actor->add_to_roles({ name => 'lead' }, { salary => 15_000_000 });
 903       # creates a new My::DBIC::Schema::Role result object and the linking table
 904       # object with an extra column in the link
 905
 906 Adds a linking table object. If the first argument is a hash reference, the
 907 related object is created first with the column values in the hash. If an object
 908 reference is given, just the linking table object is created. In either case,
 909 any additional column values for the linking table object can be specified in
 910 C<\%link_col_data>.
 911
 912 See L<DBIx::Class::Relationship/many_to_many> for additional details.
 913
 914 =head2 set_$rel
 915
 916 B<Currently only available for C<many_to_many> relationships.>
 917
 918 =over 4
 919
 920 =item Arguments: (\@hashrefs_of_col_data | L<\@result_objs|DBIx::Class::Manual::ResultClass>), $link_vals?
 921
 922 =item Return Value: not defined
 923
 924 =back
 925
 926   my $actor = $schema->resultset('Actor')->find(1);
 927   my @roles = $schema->resultset('Role')->search({ role =>
 928      { '-in' => ['Fred', 'Barney'] } } );
 929
 930   $actor->set_roles(\@roles);
 931      # Replaces all of $actor's previous roles with the two named
 932
 933   $actor->set_roles(\@roles, { salary => 15_000_000 });
 934      # Sets a column in the link table for all roles
 935
 936
 937 Replace all the related objects with the given reference to a list of
 938 objects. This does a C<delete> B<on the link table resultset> to remove the
 939 association between the current object and all related objects, then calls
 940 C<add_to_$rel> repeatedly to link all the new objects.
 941
 942 Note that this means that this method will B<not> delete any objects in the
 943 table on the right side of the relation, merely that it will delete the link
 944 between them.
 945
 946 Due to a mistake in the original implementation of this method, it will also
 947 accept a list of objects or hash references. This is B<deprecated> and will be
 948 removed in a future version.
 949
 950 =head2 remove_from_$rel
 951
 952 B<Currently only available for C<many_to_many> relationships.>
 953
 954 =over 4
 955
 956 =item Arguments: L<$result|DBIx::Class::Manual::ResultClass>
 957
 958 =item Return Value: not defined
 959
 960 =back
 961
 962   my $role = $schema->resultset('Role')->find(1);
 963   $actor->remove_from_roles($role);
 964       # removes $role's My::DBIC::Schema::ActorRoles linking table result object
 965
 966 Removes the link between the current object and the related object. Note that
 967 the related object itself won't be deleted unless you call ->delete() on
 968 it. This method just removes the link between the two objects.
 969
 970 =head1 AUTHOR AND CONTRIBUTORS
 971
 972 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
 973
 974 =head1 LICENSE
 975
 976 You may distribute this code under the same terms as Perl itself.
 977
 978 =cut
 979
 980 1;