1 package DBIx::Class::PK;
6 use base qw/DBIx::Class::Row/;
10 DBIx::Class::PK - Primary Key class
16 This class contains methods for handling primary keys and methods
25 Returns the primary key(s) for a row. Can't be called as
32 $self->throw_exception( "Can't call id() as a class method" )
34 my @id_vals = $self->_ident_values;
35 return (wantarray ? @id_vals : $id_vals[0]);
42 for ($self->_pri_cols) {
43 push @ids, $self->get_column($_);
44 push @missing, $_ if (! defined $ids[-1] and ! $self->has_column_loaded ($_) );
47 if (@missing && $self->in_storage) {
48 $self->throw_exception (
49 'Unable to uniquely identify row object with missing PK columns: '
50 . join (', ', @missing )
59 Returns a unique id string identifying a row object by primary key.
60 Used by L<DBIx::Class::CDBICompat::LiveObjectIndex> and
61 L<DBIx::Class::ObjectCache>.
67 The default C<_create_ID> method used by this function orders the returned
68 values by the alphabetical order of the primary column names, B<unlike>
69 the L</id> method, which follows the same order in which columns were fed
70 to L<DBIx::Class::ResultSource/set_primary_key>.
78 $self->throw_exception( "Can't call ID() as a class method" )
80 return undef unless $self->in_storage;
81 return $self->_create_ID(%{$self->ident_condition});
85 my ($self, %vals) = @_;
86 return undef unless 0 == grep { !defined } values %vals;
87 return join '|', ref $self || $self, $self->result_source->name,
88 map { $_ . '=' . $vals{$_} } sort keys %vals;
91 =head2 ident_condition
93 my $cond = $result_source->ident_condition();
95 my $cond = $result_source->ident_condition('alias');
97 Produces a condition hash to locate a row based on the primary key(s).
101 sub ident_condition {
102 my ($self, $alias) = @_;
104 my @pks = $self->_pri_cols;
105 my @vals = $self->_ident_values;
108 my $prefix = defined $alias ? $alias.'.' : '';
110 if (! defined ($cond{$prefix.$col} = shift @vals) ) {
115 if (@undef && $self->in_storage) {
116 $self->throw_exception (
117 'Unable to construct row object identity condition due to NULL PK columns: '
118 . join (', ', @undef)
129 Matt S. Trout <mst@shadowcatsystems.co.uk>
133 You may distribute this code under the same terms as Perl itself.