1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
10 DBIx::Class::Row - Basic row methods
16 This class is responsible for defining and doing basic operations on rows
17 derived from L<DBIx::Class::Table> objects.
23 my $obj = My::Class->new($attrs);
25 Creates a new row object from column => value mappings passed as a hash ref
30 my ($class, $attrs) = @_;
31 $class = ref $class if ref $class;
32 my $new = bless({ _column_data => { } }, $class);
34 $new->throw("attrs must be a hashref" ) unless ref($attrs) eq 'HASH';
35 while (my ($k, $v) = each %{$attrs}) {
36 die "No such column $k on $class" unless $class->has_column($k);
37 $new->store_column($k => $v);
47 Inserts an object into the database if it isn't already in there. Returns
54 return $self if $self->in_storage;
55 #use Data::Dumper; warn Dumper($self);
56 $self->result_source->storage->insert(
57 $self->_table_name, { $self->get_columns });
59 $self->{_dirty_columns} = {};
65 $obj->in_storage; # Get value
66 $obj->in_storage(1); # Set value
68 Indicated whether the object exists as a row in the database or not
73 my ($self, $val) = @_;
74 $self->{_in_storage} = $val if @_ > 1;
75 return $self->{_in_storage};
82 Must be run on an object that is already in the database; issues an SQL
83 UPDATE query to commit any changes to the object to the db if required.
88 my ($self, $upd) = @_;
89 $self->throw( "Not in database" ) unless $self->in_storage;
90 my %to_update = $self->get_dirty_columns;
91 return $self unless keys %to_update;
92 my $rows = $self->result_source->storage->update(
93 $self->result_source->from, \%to_update, $self->ident_condition);
95 $self->throw( "Can't update ${self}: row not found" );
97 $self->throw("Can't update ${self}: updated more than one row");
99 $self->{_dirty_columns} = {};
107 Deletes the object from the database. The object is still perfectly usable
108 accessor-wise etc. but ->in_storage will now return 0 and the object must
109 be re ->insert'ed before it can be ->update'ed
116 $self->throw( "Not in database" ) unless $self->in_storage;
117 $self->result_source->storage->delete(
118 $self->result_source->from, $self->ident_condition);
119 $self->in_storage(undef);
122 if (@_ > 1 && ref $_[$#_] eq 'HASH') {
123 $attrs = { %{ pop(@_) } };
125 my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_});
126 $self->result_source->resultset->search(@_)->delete;
133 my $val = $obj->get_column($col);
135 Gets a column value from a row object. Currently, does not do
136 any queries; the column must have already been fetched from
137 the database and stored in the object.
142 my ($self, $column) = @_;
143 $self->throw( "Can't fetch data as class method" ) unless ref $self;
144 return $self->{_column_data}{$column}
145 if exists $self->{_column_data}{$column};
146 $self->throw( "No such column '${column}'" ) unless $self->has_column($column);
152 my %data = $obj->get_columns;
154 Does C<get_column>, for all column values at once.
160 return return %{$self->{_column_data}};
163 =head2 get_dirty_columns
165 my %data = $obj->get_dirty_columns;
167 Identical to get_columns but only returns those that have been changed.
171 sub get_dirty_columns {
173 return map { $_ => $self->{_column_data}{$_} }
174 keys %{$self->{_dirty_columns}};
179 $obj->set_column($col => $val);
181 Sets a column value. If the new value is different from the old one,
182 the column is marked as dirty for when you next call $obj->update.
189 my $old = $self->get_column($column);
190 my $ret = $self->store_column(@_);
191 $self->{_dirty_columns}{$column} = 1
192 if (defined $old ^ defined $ret) || (defined $old && $old ne $ret);
198 my $copy = $orig->set_columns({ $col => $val, ... });
200 Sets more than one column value at once.
205 my ($self,$data) = @_;
206 while (my ($col,$val) = each %$data) {
207 $self->set_column($col,$val);
214 my $copy = $orig->copy({ change => $to, ... });
216 Inserts a new row with the specified changes.
221 my ($self, $changes) = @_;
222 my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self);
223 $new->set_column($_ => $changes->{$_}) for keys %$changes;
229 $obj->store_column($col => $val);
231 Sets a column value without marking it as dirty.
236 my ($self, $column, $value) = @_;
237 $self->throw( "No such column '${column}'" )
238 unless exists $self->{_column_data}{$column} || $self->has_column($column);
239 $self->throw( "set_column called for ${column} without value" )
241 return $self->{_column_data}{$column} = $value;
244 =head2 inflate_result
246 Class->inflate_result($result_source, \%me, \%prefetch?)
248 Called by ResultSet to inflate a result from storage
253 my ($class, $source, $me, $prefetch) = @_;
254 #use Data::Dumper; print Dumper(@_);
255 my $new = bless({ result_source => $source,
259 ref $class || $class);
261 PRE: foreach my $pre (keys %{$prefetch||{}}) {
262 my $rel_obj = $class->relationship_info($pre);
263 die "Can't prefetch non-eistant relationship ${pre}" unless $rel_obj;
264 $schema ||= $source->schema;
265 my $pre_class = $schema->class($rel_obj->{class});
266 my $fetched = $pre_class->inflate_result(
267 $schema->source($pre_class), @{$prefetch->{$pre}});
268 $class->throw("No accessor for prefetched $pre")
269 unless defined $rel_obj->{attrs}{accessor};
270 PRIMARY: foreach my $pri ($rel_obj->{class}->primary_columns) {
271 unless (defined $fetched->get_column($pri)) {
276 if ($rel_obj->{attrs}{accessor} eq 'single') {
277 $new->{_relationship_data}{$pre} = $fetched;
278 } elsif ($rel_obj->{attrs}{accessor} eq 'filter') {
279 $new->{_inflated_column}{$pre} = $fetched;
281 $class->throw("Don't know how to store prefetched $pre");
287 =head2 insert_or_update
289 $obj->insert_or_update
291 Updates the object if it's already in the db, else inserts it.
295 sub insert_or_update {
297 return ($self->in_storage ? $self->update : $self->insert);
302 my @changed_col_names = $obj->is_changed
307 return keys %{shift->{_dirty_columns} || {}};
314 Matt S. Trout <mst@shadowcatsystems.co.uk>
318 You may distribute this code under the same terms as Perl itself.