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 __PACKAGE__->mk_classdata('_relationships', { } );
  17
  18 =head1 NAME
  19
  20 DBIx::Class::Relationship - Inter-table relationships
  21
  22 =head1 SYNOPSIS
  23
  24 =head1 DESCRIPTION
  25
  26 This class handles relationships between the tables in your database
  27 model. It allows you to set up relationships and perform joins on them.
  28
  29 Only the helper methods for setting up standard relationship types
  30 are documented here. For the basic, lower-level methods, see
  31 L<DBIx::Class::Relationship::Base>.
  32
  33 =head1 METHODS
  34
  35 All helper methods take the following arguments:
  36
  37   __PACKAGE__>$method_name('relname', 'Foreign::Class', $cond, $attrs);
  38
  39 Both C<$cond> and C<$attrs> are optional. Pass C<undef> for C<$cond> if
  40 you want to use the default value for it, but still want to set C<$attrs>.
  41 See L<DBIx::Class::Relationship::Base> for a list of valid attributes.
  42
  43 =head2 belongs_to
  44
  45   # in a Bar class (where Foo has many Bars)
  46   __PACKAGE__->belongs_to(foo => Foo);
  47   my $f_obj = $obj->foo;
  48   $obj->foo($new_f_obj);
  49
  50 Creates a relationship where the calling class stores the foreign class's
  51 primary key in one (or more) of its columns. If $cond is a column name
  52 instead of a join condition hash, that is used as the name of the column
  53 holding the foreign key. If $cond is not given, the relname is used as
  54 the column name.
  55
  56 NOTE: If you are used to L<Class::DBI> relationships, this is the equivalent
  57 of C<has_a>.
  58
  59 =head2 has_many
  60
  61   # in a Foo class (where Foo has many Bars)
  62   __PACKAGE__->has_many(bar => Bar, 'foo');
  63   my $f_resultset = $obj->foo;
  64   my $f_resultset = $obj->foo({ name => { LIKE => '%macaroni%' }, { prefetch => [qw/bar/] });
  65   my @f_obj = $obj->foo;
  66
  67   $obj->add_to_foo(\%col_data);
  68
  69 Creates a one-to-many relationship, where the corresponding elements of the
  70 foreign class store the calling class's primary key in one (or more) of its
  71 columns. You should pass the name of the column in the foreign class as the
  72 $cond argument, or specify a complete join condition.
  73
  74 If you delete an object in a class with a C<has_many> relationship, all
  75 related objects will be deleted as well. However, any database-level
  76 cascade or restrict will take precedence.
  77
  78 =head2 might_have
  79
  80   __PACKAGE__->might_have(baz => Baz);
  81   my $f_obj = $obj->baz; # to get the baz object
  82
  83 Creates an optional one-to-one relationship with a class, where the foreign class
  84 stores our primary key in one of its columns. Defaults to the primary key of the
  85 foreign class unless $cond specifies a column or join condition.
  86
  87 If you update or delete an object in a class with a C<might_have> relationship,
  88 the related object will be updated or deleted as well. Any database-level update
  89 or delete constraints will override this behavior.
  90
  91 =head2 has_one
  92
  93   __PACKAGE__->has_one(gorch => Gorch);
  94   my $f_obj = $obj->gorch;
  95
  96 Creates a one-to-one relationship with another class. This is just like C<might_have>,
  97 except the implication is that the other object is always present. The only different
  98 between C<has_one> and C<might_have> is that C<has_one> uses an (ordinary) inner join,
  99 whereas C<might_have> uses a left join.
 100
 101
 102 =head2 many_to_many
 103
 104   __PACKAGE__->many_to_many( 'accessorname' => 'a_to_b', 'table_b' );
 105   my @f_objs = $obj_a->accessorname;
 106
 107 =cut
 108
 109 1;
 110
 111 =head1 AUTHORS
 112
 113 Matt S. Trout <mst@shadowcatsystems.co.uk>
 114
 115 =head1 LICENSE
 116
 117 You may distribute this code under the same terms as Perl itself.
 118
 119 =cut
 120