1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
7 use Carp::Clan qw/^DBIx::Class/;
17 $ENV{DBIC_MULTICREATE_DEBUG}
22 __PACKAGE__->mk_group_accessors('simple' => qw/_source_handle/);
26 DBIx::Class::Row - Basic row methods
32 This class is responsible for defining and doing basic operations on rows
33 derived from L<DBIx::Class::ResultSource> objects.
35 Row objects are returned from L<DBIx::Class::ResultSet>s using the
36 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
37 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
38 as well as invocations of 'single' (
39 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
40 L<has_one|DBIx::Class::Relationship/has_one> or
41 L<might_have|DBIx::Class::Relationship/might_have>)
42 relationship accessors of L<DBIx::Class::Row> objects.
48 my $row = My::Class->new(\%attrs);
50 my $row = $schema->resultset('MySource')->new(\%colsandvalues);
54 =item Arguments: \%attrs or \%colsandvalues
56 =item Returns: A Row object
60 While you can create a new row object by calling C<new> directly on
61 this class, you are better off calling it on a
62 L<DBIx::Class::ResultSet> object.
64 When calling it directly, you will not get a complete, usable row
65 object until you pass or set the C<source_handle> attribute, to a
66 L<DBIx::Class::ResultSource> instance that is attached to a
67 L<DBIx::Class::Schema> with a valid connection.
69 C<$attrs> is a hashref of column name, value data. It can also contain
70 some other attributes such as the C<source_handle>.
72 Passing an object, or an arrayref of objects as a value will call
73 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
74 passed a hashref or an arrayref of hashrefs as the value, these will
75 be turned into objects via new_related, and treated as if you had
78 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
82 ## It needs to store the new objects somewhere, and call insert on that list later when insert is called on this object. We may need an accessor for these so the user can retrieve them, if just doing ->new().
83 ## This only works because DBIC doesnt yet care to check whether the new_related objects have been passed all their mandatory columns
84 ## When doing the later insert, we need to make sure the PKs are set.
85 ## using _relationship_data in new and funky ways..
86 ## check Relationship::CascadeActions and Relationship::Accessor for compat
89 sub __new_related_find_or_new_helper {
90 my ($self, $relname, $data) = @_;
91 if ($self->__their_pk_needs_us($relname, $data)) {
92 MULTICREATE_DEBUG and warn "MC $self constructing $relname via new_result";
93 return $self->result_source
94 ->related_source($relname)
98 if ($self->result_source->pk_depends_on($relname, $data)) {
99 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new";
100 return $self->result_source
101 ->related_source($relname)
103 ->find_or_new($data);
105 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new_related";
106 return $self->find_or_new_related($relname, $data);
109 sub __their_pk_needs_us { # this should maybe be in resultsource.
110 my ($self, $relname, $data) = @_;
111 my $source = $self->result_source;
112 my $reverse = $source->reverse_relationship_info($relname);
113 my $rel_source = $source->related_source($relname);
114 my $us = { $self->get_columns };
115 foreach my $key (keys %$reverse) {
116 # if their primary key depends on us, then we have to
117 # just create a result and we'll fill it out afterwards
118 return 1 if $rel_source->pk_depends_on($key, $us);
124 my ($class, $attrs) = @_;
125 $class = ref $class if ref $class;
132 if (my $handle = delete $attrs->{-source_handle}) {
133 $new->_source_handle($handle);
137 if ($source = delete $attrs->{-result_source}) {
138 $new->result_source($source);
141 if (my $related = delete $attrs->{-from_resultset}) {
142 @{$new->{_ignore_at_insert}={}}{@$related} = ();
146 $new->throw_exception("attrs must be a hashref")
147 unless ref($attrs) eq 'HASH';
149 my ($related,$inflated);
150 ## Pretend all the rels are actual objects, unset below if not, for insert() to fix
151 $new->{_rel_in_storage} = 1;
153 foreach my $key (keys %$attrs) {
154 if (ref $attrs->{$key}) {
155 ## Can we extract this lot to use with update(_or .. ) ?
156 confess "Can't do multi-create without result source" unless $source;
157 my $info = $source->relationship_info($key);
158 if ($info && $info->{attrs}{accessor}
159 && $info->{attrs}{accessor} eq 'single')
161 my $rel_obj = delete $attrs->{$key};
162 if(!Scalar::Util::blessed($rel_obj)) {
163 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
166 if ($rel_obj->in_storage) {
167 $new->set_from_related($key, $rel_obj);
169 $new->{_rel_in_storage} = 0;
170 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj\n";
173 $related->{$key} = $rel_obj;
175 } elsif ($info && $info->{attrs}{accessor}
176 && $info->{attrs}{accessor} eq 'multi'
177 && ref $attrs->{$key} eq 'ARRAY') {
178 my $others = delete $attrs->{$key};
179 my $total = @$others;
181 foreach my $idx (0 .. $#$others) {
182 my $rel_obj = $others->[$idx];
183 if(!Scalar::Util::blessed($rel_obj)) {
184 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
187 if ($rel_obj->in_storage) {
188 $new->set_from_related($key, $rel_obj);
190 $new->{_rel_in_storage} = 0;
191 MULTICREATE_DEBUG and
192 warn "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
194 $new->set_from_related($key, $rel_obj) if $rel_obj->in_storage;
195 push(@objects, $rel_obj);
197 $related->{$key} = \@objects;
199 } elsif ($info && $info->{attrs}{accessor}
200 && $info->{attrs}{accessor} eq 'filter')
202 ## 'filter' should disappear and get merged in with 'single' above!
203 my $rel_obj = delete $attrs->{$key};
204 if(!Scalar::Util::blessed($rel_obj)) {
205 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
207 unless ($rel_obj->in_storage) {
208 $new->{_rel_in_storage} = 0;
209 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj";
211 $inflated->{$key} = $rel_obj;
213 } elsif ($class->has_column($key)
214 && $class->column_info($key)->{_inflate_info}) {
215 $inflated->{$key} = $attrs->{$key};
219 $new->throw_exception("No such column $key on $class")
220 unless $class->has_column($key);
221 $new->store_column($key => $attrs->{$key});
224 $new->{_relationship_data} = $related if $related;
225 $new->{_inflated_column} = $inflated if $inflated;
237 =item Arguments: none
239 =item Returns: The Row object
243 Inserts an object previously created by L</new> into the database if
244 it isn't already in there. Returns the object itself. Requires the
245 object's result source to be set, or the class to have a
246 result_source_instance method. To insert an entirely new row into
247 the database, use C<create> (see L<DBIx::Class::ResultSet/create>).
249 To fetch an uninserted row object, call
250 L<new|DBIx::Class::ResultSet/new> on a resultset.
252 This will also insert any uninserted, related objects held inside this
253 one, see L<DBIx::Class::ResultSet/create> for more details.
259 return $self if $self->in_storage;
260 my $source = $self->result_source;
261 $source ||= $self->result_source($self->result_source_instance)
262 if $self->can('result_source_instance');
263 $self->throw_exception("No result_source set on this object; can't insert")
268 # Check if we stored uninserted relobjs here in new()
269 my %related_stuff = (%{$self->{_relationship_data} || {}},
270 %{$self->{_inflated_column} || {}});
272 if(!$self->{_rel_in_storage}) {
274 # The guard will save us if we blow out of this scope via die
275 $rollback_guard = $source->storage->txn_scope_guard;
277 ## Should all be in relationship_data, but we need to get rid of the
278 ## 'filter' reltype..
279 ## These are the FK rels, need their IDs for the insert.
281 my @pri = $self->primary_columns;
283 REL: foreach my $relname (keys %related_stuff) {
285 my $rel_obj = $related_stuff{$relname};
287 next REL unless (Scalar::Util::blessed($rel_obj)
288 && $rel_obj->isa('DBIx::Class::Row'));
290 next REL unless $source->pk_depends_on(
291 $relname, { $rel_obj->get_columns }
294 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
296 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_inflated_columns };
297 my $re = $self->result_source
298 ->related_source($relname)
300 ->find_or_create($them);
301 %{$rel_obj} = %{$re};
302 $self->set_from_related($relname, $rel_obj);
303 delete $related_stuff{$relname};
307 MULTICREATE_DEBUG and do {
308 no warnings 'uninitialized';
309 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
311 my $updated_cols = $source->storage->insert($source, { $self->get_columns });
312 foreach my $col (keys %$updated_cols) {
313 $self->store_column($col, $updated_cols->{$col});
317 my @auto_pri = grep {
318 !defined $self->get_column($_) ||
319 ref($self->get_column($_)) eq 'SCALAR'
320 } $self->primary_columns;
323 #$self->throw_exception( "More than one possible key found for auto-inc on ".ref $self )
324 # if defined $too_many;
325 MULTICREATE_DEBUG and warn "MC $self fetching missing PKs ".join(', ', @auto_pri)."\n";
326 my $storage = $self->result_source->storage;
327 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
328 unless $storage->can('last_insert_id');
329 my @ids = $storage->last_insert_id($self->result_source,@auto_pri);
330 $self->throw_exception( "Can't get last insert id" )
331 unless (@ids == @auto_pri);
332 $self->store_column($auto_pri[$_] => $ids[$_]) for 0 .. $#ids;
333 #use Data::Dumper; warn Dumper($self);
337 $self->{_dirty_columns} = {};
338 $self->{related_resultsets} = {};
340 if(!$self->{_rel_in_storage}) {
341 ## Now do the relationships that need our ID (has_many etc.)
342 foreach my $relname (keys %related_stuff) {
343 my $rel_obj = $related_stuff{$relname};
345 if (Scalar::Util::blessed($rel_obj)
346 && $rel_obj->isa('DBIx::Class::Row')) {
348 } elsif (ref $rel_obj eq 'ARRAY') {
352 my $reverse = $source->reverse_relationship_info($relname);
353 foreach my $obj (@cands) {
354 $obj->set_from_related($_, $self) for keys %$reverse;
355 my $them = { %{$obj->{_relationship_data} || {} }, $obj->get_inflated_columns };
356 if ($self->__their_pk_needs_us($relname, $them)) {
357 if (exists $self->{_ignore_at_insert}{$relname}) {
358 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
360 MULTICREATE_DEBUG and warn "MC $self re-creating $relname $obj";
361 my $re = $self->result_source
362 ->related_source($relname)
364 ->find_or_create($them);
366 MULTICREATE_DEBUG and warn "MC $self new $relname $obj";
369 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
375 delete $self->{_ignore_at_insert};
376 $rollback_guard->commit;
379 $self->in_storage(1);
380 undef $self->{_orig_ident};
386 $row->in_storage; # Get value
387 $row->in_storage(1); # Set value
391 =item Arguments: none or 1|0
397 Indicates whether the object exists as a row in the database or
398 not. This is set to true when L<DBIx::Class::ResultSet/find>,
399 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
402 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
403 L</delete> on one, sets it to false.
408 my ($self, $val) = @_;
409 $self->{_in_storage} = $val if @_ > 1;
410 return $self->{_in_storage};
415 $row->update(\%columns?)
419 =item Arguments: none or a hashref
421 =item Returns: The Row object
425 Throws an exception if the row object is not yet in the database,
426 according to L</in_storage>.
428 This method issues an SQL UPDATE query to commit any changes to the
429 object to the database if required.
431 Also takes an optional hashref of C<< column_name => value> >> pairs
432 to update on the object first. Be aware that the hashref will be
433 passed to C<set_inflated_columns>, which might edit it in place, so
434 don't rely on it being the same after a call to C<update>. If you
435 need to preserve the hashref, it is sufficient to pass a shallow copy
436 to C<update>, e.g. ( { %{ $href } } )
438 If the values passed or any of the column values set on the object
439 contain scalar references, eg:
441 $row->last_modified(\'NOW()');
443 $row->update({ last_modified => \'NOW()' });
445 The update will pass the values verbatim into SQL. (See
446 L<SQL::Abstract> docs). The values in your Row object will NOT change
447 as a result of the update call, if you want the object to be updated
448 with the actual values from the database, call L</discard_changes>
451 $row->update()->discard_changes();
453 To determine before calling this method, which column values have
454 changed and will be updated, call L</get_dirty_columns>.
456 To check if any columns will be updated, call L</is_changed>.
458 To force a column to be updated, call L</make_column_dirty> before
464 my ($self, $upd) = @_;
465 $self->throw_exception( "Not in database" ) unless $self->in_storage;
466 my $ident_cond = $self->ident_condition;
467 $self->throw_exception("Cannot safely update a row in a PK-less table")
468 if ! keys %$ident_cond;
470 $self->set_inflated_columns($upd) if $upd;
471 my %to_update = $self->get_dirty_columns;
472 return $self unless keys %to_update;
473 my $rows = $self->result_source->storage->update(
474 $self->result_source, \%to_update,
475 $self->{_orig_ident} || $ident_cond
478 $self->throw_exception( "Can't update ${self}: row not found" );
479 } elsif ($rows > 1) {
480 $self->throw_exception("Can't update ${self}: updated more than one row");
482 $self->{_dirty_columns} = {};
483 $self->{related_resultsets} = {};
484 undef $self->{_orig_ident};
494 =item Arguments: none
496 =item Returns: The Row object
500 Throws an exception if the object is not in the database according to
501 L</in_storage>. Runs an SQL DELETE statement using the primary key
502 values to locate the row.
504 The object is still perfectly usable, but L</in_storage> will
505 now return 0 and the object must be reinserted using L</insert>
506 before it can be used to L</update> the row again.
508 If you delete an object in a class with a C<has_many> relationship, an
509 attempt is made to delete all the related objects as well. To turn
510 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
511 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
512 database-level cascade or restrict will take precedence over a
513 DBIx-Class-based cascading delete.
515 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
516 and the transaction subsequently fails, the row object will remain marked as
517 not being in storage. If you know for a fact that the object is still in
518 storage (i.e. by inspecting the cause of the transaction's failure), you can
519 use C<< $obj->in_storage(1) >> to restore consistency between the object and
520 the database. This would allow a subsequent C<< $obj->delete >> to work
523 See also L<DBIx::Class::ResultSet/delete>.
530 $self->throw_exception( "Not in database" ) unless $self->in_storage;
531 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
532 $self->throw_exception("Cannot safely delete a row in a PK-less table")
533 if ! keys %$ident_cond;
534 foreach my $column (keys %$ident_cond) {
535 $self->throw_exception("Can't delete the object unless it has loaded the primary keys")
536 unless exists $self->{_column_data}{$column};
538 $self->result_source->storage->delete(
539 $self->result_source, $ident_cond);
540 $self->in_storage(undef);
542 $self->throw_exception("Can't do class delete without a ResultSource instance")
543 unless $self->can('result_source_instance');
544 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
545 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
546 $self->result_source_instance->resultset->search(@_)->delete;
553 my $val = $row->get_column($col);
557 =item Arguments: $columnname
559 =item Returns: The value of the column
563 Throws an exception if the column name given doesn't exist according
566 Returns a raw column value from the row object, if it has already
567 been fetched from the database or set by an accessor.
569 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
570 will be deflated and returned.
572 Note that if you used the C<columns> or the C<select/as>
573 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
574 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
575 this method will return C<undef> even if the database contains some value.
577 To retrieve all loaded column values as a hash, use L</get_columns>.
582 my ($self, $column) = @_;
583 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
584 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
585 if (exists $self->{_inflated_column}{$column}) {
586 return $self->store_column($column,
587 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
589 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
593 =head2 has_column_loaded
595 if ( $row->has_column_loaded($col) ) {
596 print "$col has been loaded from db";
601 =item Arguments: $columnname
607 Returns a true value if the column value has been loaded from the
608 database (or set locally).
612 sub has_column_loaded {
613 my ($self, $column) = @_;
614 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
615 return 1 if exists $self->{_inflated_column}{$column};
616 return exists $self->{_column_data}{$column};
621 my %data = $row->get_columns;
625 =item Arguments: none
627 =item Returns: A hash of columnname, value pairs.
631 Returns all loaded column data as a hash, containing raw values. To
632 get just one value for a particular column, use L</get_column>.
638 if (exists $self->{_inflated_column}) {
639 foreach my $col (keys %{$self->{_inflated_column}}) {
640 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
641 unless exists $self->{_column_data}{$col};
644 return %{$self->{_column_data}};
647 =head2 get_dirty_columns
649 my %data = $row->get_dirty_columns;
653 =item Arguments: none
655 =item Returns: A hash of column, value pairs
659 Only returns the column, value pairs for those columns that have been
660 changed on this object since the last L</update> or L</insert> call.
662 See L</get_columns> to fetch all column/value pairs.
666 sub get_dirty_columns {
668 return map { $_ => $self->{_column_data}{$_} }
669 keys %{$self->{_dirty_columns}};
672 =head2 make_column_dirty
674 $row->make_column_dirty($col)
678 =item Arguments: $columnname
680 =item Returns: undefined
684 Throws an exception if the column does not exist.
686 Marks a column as having been changed regardless of whether it has
690 sub make_column_dirty {
691 my ($self, $column) = @_;
693 $self->throw_exception( "No such column '${column}'" )
694 unless exists $self->{_column_data}{$column} || $self->has_column($column);
695 $self->{_dirty_columns}{$column} = 1;
698 =head2 get_inflated_columns
700 my %inflated_data = $obj->get_inflated_columns;
704 =item Arguments: none
706 =item Returns: A hash of column, object|value pairs
710 Returns a hash of all column keys and associated values. Values for any
711 columns set to use inflation will be inflated and returns as objects.
713 See L</get_columns> to get the uninflated values.
715 See L<DBIx::Class::InflateColumn> for how to setup inflation.
719 sub get_inflated_columns {
722 my $accessor = $self->column_info($_)->{'accessor'} || $_;
723 ($_ => $self->$accessor);
724 } grep $self->has_column_loaded($_), $self->columns;
729 $row->set_column($col => $val);
733 =item Arguments: $columnname, $value
735 =item Returns: $value
739 Sets a raw column value. If the new value is different from the old one,
740 the column is marked as dirty for when you next call L</update>.
742 If passed an object or reference as a value, this method will happily
743 attempt to store it, and a later L</insert> or L</update> will try and
744 stringify/numify as appropriate. To set an object to be deflated
745 instead, see L</set_inflated_columns>.
750 my ($self, $column, $new_value) = @_;
752 $self->{_orig_ident} ||= $self->ident_condition;
753 my $old_value = $self->get_column($column);
755 $self->store_column($column, $new_value);
756 $self->{_dirty_columns}{$column} = 1
757 if (defined $old_value xor defined $new_value) || (defined $old_value && $old_value ne $new_value);
759 # XXX clear out the relation cache for this column
760 delete $self->{related_resultsets}{$column};
767 $row->set_columns({ $col => $val, ... });
771 =item Arguments: \%columndata
773 =item Returns: The Row object
777 Sets multiple column, raw value pairs at once.
779 Works as L</set_column>.
784 my ($self,$data) = @_;
785 foreach my $col (keys %$data) {
786 $self->set_column($col,$data->{$col});
791 =head2 set_inflated_columns
793 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
797 =item Arguments: \%columndata
799 =item Returns: The Row object
803 Sets more than one column value at once. Any inflated values are
804 deflated and the raw values stored.
806 Any related values passed as Row objects, using the relation name as a
807 key, are reduced to the appropriate foreign key values and stored. If
808 instead of related row objects, a hashref of column, value data is
809 passed, will create the related object first then store.
811 Will even accept arrayrefs of data as a value to a
812 L<DBIx::Class::Relationship/has_many> key, and create the related
813 objects if necessary.
815 Be aware that the input hashref might be edited in place, so dont rely
816 on it being the same after a call to C<set_inflated_columns>. If you
817 need to preserve the hashref, it is sufficient to pass a shallow copy
818 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
820 See also L<DBIx::Class::Relationship::Base/set_from_related>.
824 sub set_inflated_columns {
825 my ( $self, $upd ) = @_;
826 foreach my $key (keys %$upd) {
827 if (ref $upd->{$key}) {
828 my $info = $self->relationship_info($key);
829 if ($info && $info->{attrs}{accessor}
830 && $info->{attrs}{accessor} eq 'single')
832 my $rel = delete $upd->{$key};
833 $self->set_from_related($key => $rel);
834 $self->{_relationship_data}{$key} = $rel;
835 } elsif ($info && $info->{attrs}{accessor}
836 && $info->{attrs}{accessor} eq 'multi') {
837 $self->throw_exception(
838 "Recursive update is not supported over relationships of type multi ($key)"
841 elsif ($self->has_column($key)
842 && exists $self->column_info($key)->{_inflate_info})
844 $self->set_inflated_column($key, delete $upd->{$key});
848 $self->set_columns($upd);
853 my $copy = $orig->copy({ change => $to, ... });
857 =item Arguments: \%replacementdata
859 =item Returns: The Row object copy
863 Inserts a new row into the database, as a copy of the original
864 object. If a hashref of replacement data is supplied, these will take
865 precedence over data in the original.
867 If the row has related objects in a
868 L<DBIx::Class::Relationship/has_many> then those objects may be copied
869 too depending on the L<cascade_copy|DBIx::Class::Relationship>
870 relationship attribute.
875 my ($self, $changes) = @_;
877 my $col_data = { %{$self->{_column_data}} };
878 foreach my $col (keys %$col_data) {
879 delete $col_data->{$col}
880 if $self->result_source->column_info($col)->{is_auto_increment};
883 my $new = { _column_data => $col_data };
884 bless $new, ref $self;
886 $new->result_source($self->result_source);
887 $new->set_inflated_columns($changes);
890 # Its possible we'll have 2 relations to the same Source. We need to make
891 # sure we don't try to insert the same row twice esle we'll violate unique
893 my $rels_copied = {};
895 foreach my $rel ($self->result_source->relationships) {
896 my $rel_info = $self->result_source->relationship_info($rel);
898 next unless $rel_info->{attrs}{cascade_copy};
900 my $resolved = $self->result_source->resolve_condition(
901 $rel_info->{cond}, $rel, $new
904 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
905 foreach my $related ($self->search_related($rel)) {
906 my $id_str = join("\0", $related->id);
907 next if $copied->{$id_str};
908 $copied->{$id_str} = 1;
909 my $rel_copy = $related->copy($resolved);
918 $row->store_column($col => $val);
922 =item Arguments: $columnname, $value
924 =item Returns: The value sent to storage
928 Set a raw value for a column without marking it as changed. This
929 method is used internally by L</set_column> which you should probably
932 This is the lowest level at which data is set on a row object,
933 extend this method to catch all data setting methods.
938 my ($self, $column, $value) = @_;
939 $self->throw_exception( "No such column '${column}'" )
940 unless exists $self->{_column_data}{$column} || $self->has_column($column);
941 $self->throw_exception( "set_column called for ${column} without value" )
943 return $self->{_column_data}{$column} = $value;
946 =head2 inflate_result
948 Class->inflate_result($result_source, \%me, \%prefetch?)
952 =item Arguments: $result_source, \%columndata, \%prefetcheddata
954 =item Returns: A Row object
958 All L<DBIx::Class::ResultSet> methods that retrieve data from the
959 database and turn it into row objects call this method.
961 Extend this method in your Result classes to hook into this process,
962 for example to rebless the result into a different class.
964 Reblessing can also be done more easily by setting C<result_class> in
965 your Result class. See L<DBIx::Class::ResultSource/result_class>.
970 my ($class, $source, $me, $prefetch) = @_;
972 my ($source_handle) = $source;
974 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
975 $source = $source_handle->resolve
977 $source_handle = $source->handle
981 _source_handle => $source_handle,
985 bless $new, (ref $class || $class);
988 foreach my $pre (keys %{$prefetch||{}}) {
989 my $pre_val = $prefetch->{$pre};
990 my $pre_source = $source->related_source($pre);
991 $class->throw_exception("Can't prefetch non-existent relationship ${pre}")
993 if (ref($pre_val->[0]) eq 'ARRAY') { # multi
995 foreach my $pre_rec (@$pre_val) {
996 unless ($pre_source->primary_columns == grep { exists $pre_rec->[0]{$_}
997 and defined $pre_rec->[0]{$_} } $pre_source->primary_columns) {
1000 push(@pre_objects, $pre_source->result_class->inflate_result(
1001 $pre_source, @{$pre_rec}));
1003 $new->related_resultset($pre)->set_cache(\@pre_objects);
1004 } elsif (defined $pre_val->[0]) {
1006 unless ($pre_source->primary_columns == grep { exists $pre_val->[0]{$_}
1007 and !defined $pre_val->[0]{$_} } $pre_source->primary_columns)
1009 $fetched = $pre_source->result_class->inflate_result(
1010 $pre_source, @{$pre_val});
1012 $new->related_resultset($pre)->set_cache([ $fetched ]);
1013 my $accessor = $source->relationship_info($pre)->{attrs}{accessor};
1014 $class->throw_exception("No accessor for prefetched $pre")
1015 unless defined $accessor;
1016 if ($accessor eq 'single') {
1017 $new->{_relationship_data}{$pre} = $fetched;
1018 } elsif ($accessor eq 'filter') {
1019 $new->{_inflated_column}{$pre} = $fetched;
1021 $class->throw_exception("Prefetch not supported with accessor '$accessor'");
1028 =head2 update_or_insert
1030 $row->update_or_insert
1034 =item Arguments: none
1036 =item Returns: Result of update or insert operation
1040 L</Update>s the object if it's already in the database, according to
1041 L</in_storage>, else L</insert>s it.
1043 =head2 insert_or_update
1045 $obj->insert_or_update
1047 Alias for L</update_or_insert>
1051 sub insert_or_update { shift->update_or_insert(@_) }
1053 sub update_or_insert {
1055 return ($self->in_storage ? $self->update : $self->insert);
1060 my @changed_col_names = $row->is_changed();
1061 if ($row->is_changed()) { ... }
1065 =item Arguments: none
1067 =item Returns: 0|1 or @columnnames
1071 In list context returns a list of columns with uncommited changes, or
1072 in scalar context returns a true value if there are uncommitted
1078 return keys %{shift->{_dirty_columns} || {}};
1081 =head2 is_column_changed
1083 if ($row->is_column_changed('col')) { ... }
1087 =item Arguments: $columname
1093 Returns a true value if the column has uncommitted changes.
1097 sub is_column_changed {
1098 my( $self, $col ) = @_;
1099 return exists $self->{_dirty_columns}->{$col};
1102 =head2 result_source
1104 my $resultsource = $row->result_source;
1108 =item Arguments: none
1110 =item Returns: a ResultSource instance
1114 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1122 $self->_source_handle($_[0]->handle);
1124 $self->_source_handle->resolve;
1128 =head2 register_column
1130 $column_info = { .... };
1131 $class->register_column($column_name, $column_info);
1135 =item Arguments: $columnname, \%columninfo
1137 =item Returns: undefined
1141 Registers a column on the class. If the column_info has an 'accessor'
1142 key, creates an accessor named after the value if defined; if there is
1143 no such key, creates an accessor with the same name as the column
1145 The column_info attributes are described in
1146 L<DBIx::Class::ResultSource/add_columns>
1150 sub register_column {
1151 my ($class, $col, $info) = @_;
1153 if (exists $info->{accessor}) {
1154 return unless defined $info->{accessor};
1155 $acc = [ $info->{accessor}, $col ];
1157 $class->mk_group_accessors('column' => $acc);
1160 =head2 get_from_storage
1162 my $copy = $row->get_from_storage($attrs)
1166 =item Arguments: \%attrs
1168 =item Returns: A Row object
1172 Fetches a fresh copy of the Row object from the database and returns it.
1174 If passed the \%attrs argument, will first apply these attributes to
1175 the resultset used to find the row.
1177 This copy can then be used to compare to an existing row object, to
1178 determine if any changes have been made in the database since it was
1181 To just update your Row object with any latest changes from the
1182 database, use L</discard_changes> instead.
1184 The \%attrs argument should be compatible with
1185 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1189 sub get_from_storage {
1190 my $self = shift @_;
1191 my $attrs = shift @_;
1192 my $resultset = $self->result_source->resultset;
1194 if(defined $attrs) {
1195 $resultset = $resultset->search(undef, $attrs);
1198 return $resultset->find($self->{_orig_ident} || $self->ident_condition);
1201 =head2 throw_exception
1203 See L<DBIx::Class::Schema/throw_exception>.
1207 sub throw_exception {
1209 if (ref $self && ref $self->result_source && $self->result_source->schema) {
1210 $self->result_source->schema->throw_exception(@_);
1222 =item Arguments: none
1224 =item Returns: A list of primary key values
1228 Returns the primary key(s) for a row. Can't be called as a class method.
1229 Actually implemented in L<DBIx::Class::PK>
1231 =head2 discard_changes
1233 $row->discard_changes
1237 =item Arguments: none
1239 =item Returns: nothing (updates object in-place)
1243 Retrieves and sets the row object data from the database, losing any
1246 This method can also be used to refresh from storage, retrieving any
1247 changes made since the row was last read from storage. Actually
1248 implemented in L<DBIx::Class::PK>
1256 Matt S. Trout <mst@shadowcatsystems.co.uk>
1260 You may distribute this code under the same terms as Perl itself.