Commit | Line | Data |
7624b19f |
1 | package DBIx::Class::Row; |
2 | |
3 | use strict; |
4 | use warnings; |
5 | |
1edd1722 |
6 | use base qw/DBIx::Class/; |
701da8c4 |
7 | use Carp::Clan qw/^DBIx::Class/; |
1edd1722 |
8 | |
097d3227 |
9 | __PACKAGE__->load_components(qw/AccessorGroup/); |
10 | |
11 | __PACKAGE__->mk_group_accessors('simple' => 'result_source'); |
8c49f629 |
12 | |
75d07914 |
13 | =head1 NAME |
7624b19f |
14 | |
15 | DBIx::Class::Row - Basic row methods |
16 | |
17 | =head1 SYNOPSIS |
18 | |
19 | =head1 DESCRIPTION |
20 | |
21 | This class is responsible for defining and doing basic operations on rows |
1ea77c14 |
22 | derived from L<DBIx::Class::ResultSource> objects. |
7624b19f |
23 | |
24 | =head1 METHODS |
25 | |
8091aa91 |
26 | =head2 new |
7624b19f |
27 | |
28 | my $obj = My::Class->new($attrs); |
29 | |
30 | Creates a new row object from column => value mappings passed as a hash ref |
31 | |
32 | =cut |
33 | |
34 | sub new { |
35 | my ($class, $attrs) = @_; |
36 | $class = ref $class if ref $class; |
04786a4c |
37 | |
38 | my $new = { _column_data => {} }; |
39 | bless $new, $class; |
40 | |
7624b19f |
41 | if ($attrs) { |
27f01d1f |
42 | $new->throw_exception("attrs must be a hashref") |
43 | unless ref($attrs) eq 'HASH'; |
096f4212 |
44 | if (my $source = delete $attrs->{-result_source}) { |
45 | $new->result_source($source); |
46 | } |
a2ca474b |
47 | foreach my $k (keys %$attrs) { |
27f01d1f |
48 | $new->throw_exception("No such column $k on $class") |
75d07914 |
49 | unless $class->has_column($k); |
a2ca474b |
50 | $new->store_column($k => $attrs->{$k}); |
7624b19f |
51 | } |
52 | } |
04786a4c |
53 | |
7624b19f |
54 | return $new; |
55 | } |
56 | |
8091aa91 |
57 | =head2 insert |
7624b19f |
58 | |
59 | $obj->insert; |
60 | |
b8810cc5 |
61 | Inserts an object into the database if it isn't already in |
62 | there. Returns the object itself. Requires the object's result source to |
63 | be set, or the class to have a result_source_instance method. To insert |
64 | an entirely new object into the database, use C<create> (see |
65 | L<DBIx::Class::ResultSet/create>). |
7624b19f |
66 | |
67 | =cut |
68 | |
69 | sub insert { |
70 | my ($self) = @_; |
71 | return $self if $self->in_storage; |
097d3227 |
72 | $self->{result_source} ||= $self->result_source_instance |
73 | if $self->can('result_source_instance'); |
74 | my $source = $self->{result_source}; |
aeb1bf75 |
75 | $self->throw_exception("No result_source set on this object; can't insert") |
76 | unless $source; |
7624b19f |
77 | #use Data::Dumper; warn Dumper($self); |
097d3227 |
78 | $source->storage->insert($source->from, { $self->get_columns }); |
7624b19f |
79 | $self->in_storage(1); |
80 | $self->{_dirty_columns} = {}; |
64acc2bc |
81 | $self->{related_resultsets} = {}; |
729b29ae |
82 | undef $self->{_orig_ident}; |
7624b19f |
83 | return $self; |
84 | } |
85 | |
8091aa91 |
86 | =head2 in_storage |
7624b19f |
87 | |
88 | $obj->in_storage; # Get value |
89 | $obj->in_storage(1); # Set value |
90 | |
91 | Indicated whether the object exists as a row in the database or not |
92 | |
93 | =cut |
94 | |
95 | sub in_storage { |
96 | my ($self, $val) = @_; |
97 | $self->{_in_storage} = $val if @_ > 1; |
98 | return $self->{_in_storage}; |
99 | } |
100 | |
8091aa91 |
101 | =head2 update |
7624b19f |
102 | |
103 | $obj->update; |
104 | |
105 | Must be run on an object that is already in the database; issues an SQL |
d3b0e369 |
106 | UPDATE query to commit any changes to the object to the database if |
107 | required. |
7624b19f |
108 | |
109 | =cut |
110 | |
111 | sub update { |
112 | my ($self, $upd) = @_; |
bd3d5a5e |
113 | # Create a copy so we dont mess with original |
114 | $upd = { %$upd } if $upd; |
115 | |
701da8c4 |
116 | $self->throw_exception( "Not in database" ) unless $self->in_storage; |
c56897b4 |
117 | my $ident_cond = $self->ident_condition; |
118 | $self->throw_exception("Cannot safely update a row in a PK-less table") |
119 | if ! keys %$ident_cond; |
5a9e0e60 |
120 | $self->set_columns($upd) if $upd; |
121 | my %to_update = $self->get_dirty_columns; |
122 | return $self unless keys %to_update; |
88cb6a1d |
123 | my $rows = $self->result_source->storage->update( |
6c299e8b |
124 | $self->result_source->from, \%to_update, $self->{_orig_ident} || $ident_cond); |
7624b19f |
125 | if ($rows == 0) { |
701da8c4 |
126 | $self->throw_exception( "Can't update ${self}: row not found" ); |
7624b19f |
127 | } elsif ($rows > 1) { |
701da8c4 |
128 | $self->throw_exception("Can't update ${self}: updated more than one row"); |
7624b19f |
129 | } |
130 | $self->{_dirty_columns} = {}; |
64acc2bc |
131 | $self->{related_resultsets} = {}; |
729b29ae |
132 | undef $self->{_orig_ident}; |
7624b19f |
133 | return $self; |
134 | } |
135 | |
8091aa91 |
136 | =head2 delete |
7624b19f |
137 | |
138 | $obj->delete |
139 | |
b8810cc5 |
140 | Deletes the object from the database. The object is still perfectly |
141 | usable, but C<-E<gt>in_storage()> will now return 0 and the object must |
142 | reinserted using C<-E<gt>insert()> before C<-E(<gt>update()> can be used |
143 | on it. If you delete an object in a class with a C<has_many> |
144 | relationship, all the related objects will be deleted as well. To turn |
145 | this behavior off, pass C<cascade_delete => 0> in the C<$attr> |
146 | hashref. Any database-level cascade or restrict will take precedence |
147 | over a DBIx-Class-based cascading delete. See also L<DBIx::Class::ResultSet/delete>. |
7624b19f |
148 | |
149 | =cut |
150 | |
151 | sub delete { |
152 | my $self = shift; |
153 | if (ref $self) { |
701da8c4 |
154 | $self->throw_exception( "Not in database" ) unless $self->in_storage; |
4b12b3c2 |
155 | my $ident_cond = $self->ident_condition; |
156 | $self->throw_exception("Cannot safely delete a row in a PK-less table") |
157 | if ! keys %$ident_cond; |
e0f56292 |
158 | foreach my $column (keys %$ident_cond) { |
75d07914 |
159 | $self->throw_exception("Can't delete the object unless it has loaded the primary keys") |
160 | unless exists $self->{_column_data}{$column}; |
e0f56292 |
161 | } |
88cb6a1d |
162 | $self->result_source->storage->delete( |
4b12b3c2 |
163 | $self->result_source->from, $ident_cond); |
7624b19f |
164 | $self->in_storage(undef); |
7624b19f |
165 | } else { |
701da8c4 |
166 | $self->throw_exception("Can't do class delete without a ResultSource instance") |
097d3227 |
167 | unless $self->can('result_source_instance'); |
aeb1bf75 |
168 | my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {}; |
169 | my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_}; |
097d3227 |
170 | $self->result_source_instance->resultset->search(@_)->delete; |
7624b19f |
171 | } |
172 | return $self; |
173 | } |
174 | |
8091aa91 |
175 | =head2 get_column |
7624b19f |
176 | |
177 | my $val = $obj->get_column($col); |
178 | |
8091aa91 |
179 | Gets a column value from a row object. Currently, does not do |
180 | any queries; the column must have already been fetched from |
181 | the database and stored in the object. |
7624b19f |
182 | |
183 | =cut |
184 | |
185 | sub get_column { |
186 | my ($self, $column) = @_; |
701da8c4 |
187 | $self->throw_exception( "Can't fetch data as class method" ) unless ref $self; |
aeb1bf75 |
188 | return $self->{_column_data}{$column} if exists $self->{_column_data}{$column}; |
701da8c4 |
189 | $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column); |
7624b19f |
190 | return undef; |
191 | } |
192 | |
9b83fccd |
193 | =head2 has_column_loaded |
194 | |
195 | if ( $obj->has_column_loaded($col) ) { |
196 | print "$col has been loaded from db"; |
197 | } |
198 | |
199 | Returns a true value if the column value has been loaded from the |
200 | database (or set locally). |
201 | |
202 | =cut |
203 | |
def81720 |
204 | sub has_column_loaded { |
205 | my ($self, $column) = @_; |
206 | $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self; |
aeb1bf75 |
207 | return exists $self->{_column_data}{$column}; |
def81720 |
208 | } |
209 | |
8091aa91 |
210 | =head2 get_columns |
076a6864 |
211 | |
212 | my %data = $obj->get_columns; |
213 | |
8091aa91 |
214 | Does C<get_column>, for all column values at once. |
076a6864 |
215 | |
216 | =cut |
217 | |
218 | sub get_columns { |
219 | my $self = shift; |
cb5f2eea |
220 | return %{$self->{_column_data}}; |
d7156e50 |
221 | } |
222 | |
223 | =head2 get_dirty_columns |
224 | |
225 | my %data = $obj->get_dirty_columns; |
226 | |
227 | Identical to get_columns but only returns those that have been changed. |
228 | |
229 | =cut |
230 | |
231 | sub get_dirty_columns { |
232 | my $self = shift; |
233 | return map { $_ => $self->{_column_data}{$_} } |
234 | keys %{$self->{_dirty_columns}}; |
076a6864 |
235 | } |
236 | |
8091aa91 |
237 | =head2 set_column |
7624b19f |
238 | |
239 | $obj->set_column($col => $val); |
240 | |
8091aa91 |
241 | Sets a column value. If the new value is different from the old one, |
242 | the column is marked as dirty for when you next call $obj->update. |
7624b19f |
243 | |
244 | =cut |
245 | |
246 | sub set_column { |
247 | my $self = shift; |
248 | my ($column) = @_; |
729b29ae |
249 | $self->{_orig_ident} ||= $self->ident_condition; |
7624b19f |
250 | my $old = $self->get_column($column); |
251 | my $ret = $self->store_column(@_); |
87772e46 |
252 | $self->{_dirty_columns}{$column} = 1 |
253 | if (defined $old ^ defined $ret) || (defined $old && $old ne $ret); |
7624b19f |
254 | return $ret; |
255 | } |
256 | |
8091aa91 |
257 | =head2 set_columns |
076a6864 |
258 | |
dc818523 |
259 | my $copy = $orig->set_columns({ $col => $val, ... }); |
076a6864 |
260 | |
8091aa91 |
261 | Sets more than one column value at once. |
076a6864 |
262 | |
263 | =cut |
264 | |
265 | sub set_columns { |
266 | my ($self,$data) = @_; |
a2ca474b |
267 | foreach my $col (keys %$data) { |
268 | $self->set_column($col,$data->{$col}); |
076a6864 |
269 | } |
c01ab172 |
270 | return $self; |
076a6864 |
271 | } |
272 | |
8091aa91 |
273 | =head2 copy |
076a6864 |
274 | |
275 | my $copy = $orig->copy({ change => $to, ... }); |
276 | |
8091aa91 |
277 | Inserts a new row with the specified changes. |
076a6864 |
278 | |
279 | =cut |
280 | |
c01ab172 |
281 | sub copy { |
282 | my ($self, $changes) = @_; |
333cce60 |
283 | $changes ||= {}; |
fde6e28e |
284 | my $col_data = { %{$self->{_column_data}} }; |
285 | foreach my $col (keys %$col_data) { |
286 | delete $col_data->{$col} |
287 | if $self->result_source->column_info($col)->{is_auto_increment}; |
288 | } |
04786a4c |
289 | |
290 | my $new = { _column_data => $col_data }; |
291 | bless $new, ref $self; |
292 | |
83419ec6 |
293 | $new->result_source($self->result_source); |
ecd1f408 |
294 | $new->set_columns($changes); |
333cce60 |
295 | $new->insert; |
296 | foreach my $rel ($self->result_source->relationships) { |
297 | my $rel_info = $self->result_source->relationship_info($rel); |
298 | if ($rel_info->{attrs}{cascade_copy}) { |
299 | my $resolved = $self->result_source->resolve_condition( |
300 | $rel_info->{cond}, $rel, $new); |
301 | foreach my $related ($self->search_related($rel)) { |
302 | $related->copy($resolved); |
303 | } |
304 | } |
305 | } |
2c4c67b6 |
306 | return $new; |
c01ab172 |
307 | } |
308 | |
8091aa91 |
309 | =head2 store_column |
7624b19f |
310 | |
311 | $obj->store_column($col => $val); |
312 | |
8091aa91 |
313 | Sets a column value without marking it as dirty. |
7624b19f |
314 | |
315 | =cut |
316 | |
317 | sub store_column { |
318 | my ($self, $column, $value) = @_; |
75d07914 |
319 | $self->throw_exception( "No such column '${column}'" ) |
d7156e50 |
320 | unless exists $self->{_column_data}{$column} || $self->has_column($column); |
75d07914 |
321 | $self->throw_exception( "set_column called for ${column} without value" ) |
7624b19f |
322 | if @_ < 3; |
323 | return $self->{_column_data}{$column} = $value; |
324 | } |
325 | |
b52e9bf8 |
326 | =head2 inflate_result |
327 | |
c01ab172 |
328 | Class->inflate_result($result_source, \%me, \%prefetch?) |
b52e9bf8 |
329 | |
330 | Called by ResultSet to inflate a result from storage |
331 | |
332 | =cut |
333 | |
334 | sub inflate_result { |
c01ab172 |
335 | my ($class, $source, $me, $prefetch) = @_; |
b52e9bf8 |
336 | #use Data::Dumper; print Dumper(@_); |
04786a4c |
337 | my $new = { |
338 | result_source => $source, |
339 | _column_data => $me, |
340 | _in_storage => 1 |
341 | }; |
342 | bless $new, (ref $class || $class); |
343 | |
7fb16f1a |
344 | my $schema; |
64acc2bc |
345 | foreach my $pre (keys %{$prefetch||{}}) { |
346 | my $pre_val = $prefetch->{$pre}; |
f9cc31dd |
347 | my $pre_source = $source->related_source($pre); |
a86b1efe |
348 | $class->throw_exception("Can't prefetch non-existent relationship ${pre}") |
349 | unless $pre_source; |
0f66a01b |
350 | if (ref($pre_val->[0]) eq 'ARRAY') { # multi |
a86b1efe |
351 | my @pre_objects; |
352 | foreach my $pre_rec (@$pre_val) { |
75d07914 |
353 | unless ($pre_source->primary_columns == grep { exists $pre_rec->[0]{$_} |
5a5bec6c |
354 | and defined $pre_rec->[0]{$_} } $pre_source->primary_columns) { |
a86b1efe |
355 | next; |
356 | } |
357 | push(@pre_objects, $pre_source->result_class->inflate_result( |
358 | $pre_source, @{$pre_rec})); |
359 | } |
360 | $new->related_resultset($pre)->set_cache(\@pre_objects); |
62e87ea8 |
361 | } elsif (defined $pre_val->[0]) { |
a86b1efe |
362 | my $fetched; |
75d07914 |
363 | unless ($pre_source->primary_columns == grep { exists $pre_val->[0]{$_} |
a86b1efe |
364 | and !defined $pre_val->[0]{$_} } $pre_source->primary_columns) |
365 | { |
366 | $fetched = $pre_source->result_class->inflate_result( |
75d07914 |
367 | $pre_source, @{$pre_val}); |
a86b1efe |
368 | } |
369 | my $accessor = $source->relationship_info($pre)->{attrs}{accessor}; |
370 | $class->throw_exception("No accessor for prefetched $pre") |
371 | unless defined $accessor; |
372 | if ($accessor eq 'single') { |
373 | $new->{_relationship_data}{$pre} = $fetched; |
374 | } elsif ($accessor eq 'filter') { |
375 | $new->{_inflated_column}{$pre} = $fetched; |
376 | } else { |
377 | $class->throw_exception("Prefetch not supported with accessor '$accessor'"); |
378 | } |
b52e9bf8 |
379 | } |
380 | } |
7624b19f |
381 | return $new; |
382 | } |
383 | |
9b465d00 |
384 | =head2 update_or_insert |
7624b19f |
385 | |
9b465d00 |
386 | $obj->update_or_insert |
7624b19f |
387 | |
8091aa91 |
388 | Updates the object if it's already in the db, else inserts it. |
7624b19f |
389 | |
9b83fccd |
390 | =head2 insert_or_update |
391 | |
392 | $obj->insert_or_update |
393 | |
394 | Alias for L</update_or_insert> |
395 | |
7624b19f |
396 | =cut |
397 | |
9b465d00 |
398 | *insert_or_update = \&update_or_insert; |
399 | sub update_or_insert { |
7624b19f |
400 | my $self = shift; |
401 | return ($self->in_storage ? $self->update : $self->insert); |
402 | } |
403 | |
8091aa91 |
404 | =head2 is_changed |
7624b19f |
405 | |
228dbcb4 |
406 | my @changed_col_names = $obj->is_changed(); |
407 | if ($obj->is_changed()) { ... } |
7624b19f |
408 | |
9b83fccd |
409 | In array context returns a list of columns with uncommited changes, or |
410 | in scalar context returns a true value if there are uncommitted |
411 | changes. |
412 | |
7624b19f |
413 | =cut |
414 | |
415 | sub is_changed { |
416 | return keys %{shift->{_dirty_columns} || {}}; |
417 | } |
228dbcb4 |
418 | |
419 | =head2 is_column_changed |
420 | |
421 | if ($obj->is_column_changed('col')) { ... } |
422 | |
9b83fccd |
423 | Returns a true value if the column has uncommitted changes. |
424 | |
228dbcb4 |
425 | =cut |
426 | |
427 | sub is_column_changed { |
428 | my( $self, $col ) = @_; |
429 | return exists $self->{_dirty_columns}->{$col}; |
430 | } |
7624b19f |
431 | |
097d3227 |
432 | =head2 result_source |
433 | |
9b83fccd |
434 | my $resultsource = $object->result_source; |
097d3227 |
435 | |
9b83fccd |
436 | Accessor to the ResultSource this object was created from |
87c4e602 |
437 | |
9b83fccd |
438 | =head2 register_column |
27f01d1f |
439 | |
9b83fccd |
440 | $column_info = { .... }; |
441 | $class->register_column($column_name, $column_info); |
27f01d1f |
442 | |
9b83fccd |
443 | Registers a column on the class. If the column_info has an 'accessor' |
444 | key, creates an accessor named after the value if defined; if there is |
445 | no such key, creates an accessor with the same name as the column |
1f23a877 |
446 | |
9b83fccd |
447 | The column_info attributes are described in |
448 | L<DBIx::Class::ResultSource/add_columns> |
1f23a877 |
449 | |
097d3227 |
450 | =cut |
451 | |
1f23a877 |
452 | sub register_column { |
453 | my ($class, $col, $info) = @_; |
91b0fbd7 |
454 | my $acc = $col; |
455 | if (exists $info->{accessor}) { |
456 | return unless defined $info->{accessor}; |
457 | $acc = [ $info->{accessor}, $col ]; |
458 | } |
459 | $class->mk_group_accessors('column' => $acc); |
1f23a877 |
460 | } |
461 | |
701da8c4 |
462 | |
5160b401 |
463 | =head2 throw_exception |
701da8c4 |
464 | |
465 | See Schema's throw_exception. |
466 | |
467 | =cut |
468 | |
469 | sub throw_exception { |
470 | my $self=shift; |
471 | if (ref $self && ref $self->result_source) { |
472 | $self->result_source->schema->throw_exception(@_); |
473 | } else { |
474 | croak(@_); |
475 | } |
476 | } |
477 | |
7624b19f |
478 | 1; |
479 | |
7624b19f |
480 | =head1 AUTHORS |
481 | |
daec44b8 |
482 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
7624b19f |
483 | |
484 | =head1 LICENSE |
485 | |
486 | You may distribute this code under the same terms as Perl itself. |
487 | |
488 | =cut |