1 package DBIx::Class::PK;
7 use base qw/DBIx::Class::Row/;
9 __PACKAGE__->mk_classdata('_primaries' => {});
13 DBIx::Class::PK - Primary Key class
19 This class represents methods handling primary keys
20 and depending on them.
30 return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries});
35 return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
38 =item set_primary_key <@cols>
40 define one or more columns as primary key for this class
45 my ($class, @cols) = @_;
46 # check if primary key columns are valid columns
48 $class->throw( "Column $_ can't be used as primary key because it isn't defined in $class" )
49 unless $class->has_column($_);
52 tie %pri, 'Tie::IxHash', map { $_ => {} } @cols;
53 $class->_primaries(\%pri);
58 Finds columns based on the primary key(s).
63 my ($class, @vals) = @_;
64 my $attrs = (@vals > 1 && ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
65 my @pk = keys %{$class->_primaries};
66 $class->throw( "Can't find unless primary columns are defined" )
69 if (ref $vals[0] eq 'HASH') {
71 } elsif (@pk == @vals) {
73 @{$query}{@pk} = @vals;
74 #my $ret = ($class->search_literal($class->_ident_cond, @vals, $attrs))[0];
75 #warn "$class: ".join(', ', %{$ret->{_column_data}});
80 $class->throw( "Can't find unless all primary keys are specified" )
81 unless (keys %$query >= @pk); # If we check 'em we run afoul of uc/lc
82 # column names etc. Not sure what to do yet
83 #return $class->search($query)->next;
84 my @cols = $class->_select_columns;
85 my @row = $class->storage->select_single($class->_table_name, \@cols, $query);
86 return (@row ? $class->_row_to_object(\@cols, \@row) : ());
91 Roll back changes that hasn't been comitted to the database.
97 delete $self->{_dirty_columns};
98 return unless $self->in_storage; # Don't reload if we aren't real!
99 my ($reload) = $self->find($self->id);
100 unless ($reload) { # If we got deleted in the mean-time
101 $self->in_storage(0);
104 delete @{$self}{keys %$self};
105 @{$self}{keys %$reload} = values %$reload;
111 returns the primary key(s) for the current row. Can't be called as
118 $self->throw( "Can't call id() as a class method" ) unless ref $self;
119 my @pk = $self->_ident_values;
120 return (wantarray ? @pk : $pk[0]);
123 =item primary_columns
125 read-only accessor which returns a list of primary keys.
129 sub primary_columns {
130 return keys %{shift->_primaries};
135 $self->throw( "Can't call ID() as a class method" ) unless ref $self;
136 return undef unless $self->in_storage;
137 return $self->_create_ID(map { $_ => $self->{_column_data}{$_} } keys %{$self->_primaries});
141 my ($class,%vals) = @_;
142 return undef unless 0 == grep { !defined } values %vals;
143 $class = ref $class || $class;
144 return join '|', $class, map { $_ . '=' . $vals{$_} } sort keys %vals;
147 sub ident_condition {
150 $cond{$_} = $self->get_column($_) for $self->primary_columns;
160 Matt S. Trout <mst@shadowcatsystems.co.uk>
164 You may distribute this code under the same terms as Perl itself.