1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
8 use DBIx::Class::Exception;
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>.
80 Please note that if a value is not passed to new, no value will be sent
81 in the SQL INSERT call, and the column will therefore assume whatever
82 default value was specified in your database. While DBIC will retrieve the
83 value of autoincrement columns, it will never make an explicit database
84 trip to retrieve default values assigned by the RDBMS. You can explicitly
85 request that all values be fetched back from the database by calling
86 L</discard_changes>, or you can supply an explicit C<undef> to columns
87 with NULL as the default, and save yourself a SELECT.
91 The behavior described above will backfire if you use a foreign key column
92 with a database-defined default. If you call the relationship accessor on
93 an object that doesn't have a set value for the FK column, DBIC will throw
94 an exception, as it has no way of knowing the PK of the related object (if
99 ## 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().
100 ## This only works because DBIC doesnt yet care to check whether the new_related objects have been passed all their mandatory columns
101 ## When doing the later insert, we need to make sure the PKs are set.
102 ## using _relationship_data in new and funky ways..
103 ## check Relationship::CascadeActions and Relationship::Accessor for compat
106 sub __new_related_find_or_new_helper {
107 my ($self, $relname, $data) = @_;
108 if ($self->__their_pk_needs_us($relname, $data)) {
109 MULTICREATE_DEBUG and warn "MC $self constructing $relname via new_result";
110 return $self->result_source
111 ->related_source($relname)
115 if ($self->result_source->_pk_depends_on($relname, $data)) {
116 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new";
117 return $self->result_source
118 ->related_source($relname)
120 ->find_or_new($data);
122 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new_related";
123 return $self->find_or_new_related($relname, $data);
126 sub __their_pk_needs_us { # this should maybe be in resultsource.
127 my ($self, $relname, $data) = @_;
128 my $source = $self->result_source;
129 my $reverse = $source->reverse_relationship_info($relname);
130 my $rel_source = $source->related_source($relname);
131 my $us = { $self->get_columns };
132 foreach my $key (keys %$reverse) {
133 # if their primary key depends on us, then we have to
134 # just create a result and we'll fill it out afterwards
135 return 1 if $rel_source->_pk_depends_on($key, $us);
141 my ($class, $attrs) = @_;
142 $class = ref $class if ref $class;
149 if (my $handle = delete $attrs->{-source_handle}) {
150 $new->_source_handle($handle);
154 if ($source = delete $attrs->{-result_source}) {
155 $new->result_source($source);
158 if (my $related = delete $attrs->{-cols_from_relations}) {
159 @{$new->{_ignore_at_insert}={}}{@$related} = ();
163 $new->throw_exception("attrs must be a hashref")
164 unless ref($attrs) eq 'HASH';
166 my ($related,$inflated);
168 foreach my $key (keys %$attrs) {
169 if (ref $attrs->{$key}) {
170 ## Can we extract this lot to use with update(_or .. ) ?
171 $new->throw_exception("Can't do multi-create without result source")
173 my $info = $source->relationship_info($key);
174 my $acc_type = $info->{attrs}{accessor} || '';
175 if ($acc_type eq 'single') {
176 my $rel_obj = delete $attrs->{$key};
177 if(!Scalar::Util::blessed($rel_obj)) {
178 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
181 if ($rel_obj->in_storage) {
182 $new->{_rel_in_storage}{$key} = 1;
183 $new->set_from_related($key, $rel_obj);
185 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj\n";
188 $related->{$key} = $rel_obj;
191 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
192 my $others = delete $attrs->{$key};
193 my $total = @$others;
195 foreach my $idx (0 .. $#$others) {
196 my $rel_obj = $others->[$idx];
197 if(!Scalar::Util::blessed($rel_obj)) {
198 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
201 if ($rel_obj->in_storage) {
202 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
204 MULTICREATE_DEBUG and
205 warn "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
207 push(@objects, $rel_obj);
209 $related->{$key} = \@objects;
212 elsif ($acc_type eq 'filter') {
213 ## 'filter' should disappear and get merged in with 'single' above!
214 my $rel_obj = delete $attrs->{$key};
215 if(!Scalar::Util::blessed($rel_obj)) {
216 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
218 if ($rel_obj->in_storage) {
219 $new->{_rel_in_storage}{$key} = 1;
222 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj";
224 $inflated->{$key} = $rel_obj;
226 } elsif ($class->has_column($key)
227 && $class->column_info($key)->{_inflate_info}) {
228 $inflated->{$key} = $attrs->{$key};
232 $new->throw_exception("No such column $key on $class")
233 unless $class->has_column($key);
234 $new->store_column($key => $attrs->{$key});
237 $new->{_relationship_data} = $related if $related;
238 $new->{_inflated_column} = $inflated if $inflated;
250 =item Arguments: none
252 =item Returns: The Row object
256 Inserts an object previously created by L</new> into the database if
257 it isn't already in there. Returns the object itself. Requires the
258 object's result source to be set, or the class to have a
259 result_source_instance method. To insert an entirely new row into
260 the database, use C<create> (see L<DBIx::Class::ResultSet/create>).
262 To fetch an uninserted row object, call
263 L<new|DBIx::Class::ResultSet/new> on a resultset.
265 This will also insert any uninserted, related objects held inside this
266 one, see L<DBIx::Class::ResultSet/create> for more details.
272 return $self if $self->in_storage;
273 my $source = $self->result_source;
274 $source ||= $self->result_source($self->result_source_instance)
275 if $self->can('result_source_instance');
276 $self->throw_exception("No result_source set on this object; can't insert")
281 # Check if we stored uninserted relobjs here in new()
282 my %related_stuff = (%{$self->{_relationship_data} || {}},
283 %{$self->{_inflated_column} || {}});
285 # insert what needs to be inserted before us
287 for my $relname (keys %related_stuff) {
288 my $rel_obj = $related_stuff{$relname};
290 if (! $self->{_rel_in_storage}{$relname}) {
291 next unless (Scalar::Util::blessed($rel_obj)
292 && $rel_obj->isa('DBIx::Class::Row'));
294 next unless $source->_pk_depends_on(
295 $relname, { $rel_obj->get_columns }
298 # The guard will save us if we blow out of this scope via die
299 $rollback_guard ||= $source->storage->txn_scope_guard;
301 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
303 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_inflated_columns };
304 my $re = $self->result_source
305 ->related_source($relname)
307 ->find_or_create($them);
309 %{$rel_obj} = %{$re};
310 $self->{_rel_in_storage}{$relname} = 1;
313 $self->set_from_related($relname, $rel_obj);
314 delete $related_stuff{$relname};
317 # start a transaction here if not started yet and there is more stuff
319 if (keys %related_stuff) {
320 $rollback_guard ||= $source->storage->txn_scope_guard
323 MULTICREATE_DEBUG and do {
324 no warnings 'uninitialized';
325 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
327 my $updated_cols = $source->storage->insert($source, { $self->get_columns });
328 foreach my $col (keys %$updated_cols) {
329 $self->store_column($col, $updated_cols->{$col});
333 my @auto_pri = grep {
334 (not defined $self->get_column($_))
336 (ref($self->get_column($_)) eq 'SCALAR')
337 } $self->primary_columns;
340 MULTICREATE_DEBUG and warn "MC $self fetching missing PKs ".join(', ', @auto_pri)."\n";
341 my $storage = $self->result_source->storage;
342 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
343 unless $storage->can('last_insert_id');
344 my @ids = $storage->last_insert_id($self->result_source,@auto_pri);
345 $self->throw_exception( "Can't get last insert id" )
346 unless (@ids == @auto_pri);
347 $self->store_column($auto_pri[$_] => $ids[$_]) for 0 .. $#ids;
351 $self->{_dirty_columns} = {};
352 $self->{related_resultsets} = {};
354 foreach my $relname (keys %related_stuff) {
355 next unless $source->has_relationship ($relname);
357 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
358 ? @{$related_stuff{$relname}}
359 : $related_stuff{$relname}
363 && Scalar::Util::blessed($cands[0])
364 && $cands[0]->isa('DBIx::Class::Row')
366 my $reverse = $source->reverse_relationship_info($relname);
367 foreach my $obj (@cands) {
368 $obj->set_from_related($_, $self) for keys %$reverse;
369 my $them = { %{$obj->{_relationship_data} || {} }, $obj->get_inflated_columns };
370 if ($self->__their_pk_needs_us($relname, $them)) {
371 if (exists $self->{_ignore_at_insert}{$relname}) {
372 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
374 MULTICREATE_DEBUG and warn "MC $self re-creating $relname $obj";
375 my $re = $self->result_source
376 ->related_source($relname)
380 MULTICREATE_DEBUG and warn "MC $self new $relname $obj";
383 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
390 $self->in_storage(1);
391 delete $self->{_orig_ident};
392 delete $self->{_ignore_at_insert};
393 $rollback_guard->commit if $rollback_guard;
400 $row->in_storage; # Get value
401 $row->in_storage(1); # Set value
405 =item Arguments: none or 1|0
411 Indicates whether the object exists as a row in the database or
412 not. This is set to true when L<DBIx::Class::ResultSet/find>,
413 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
416 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
417 L</delete> on one, sets it to false.
422 my ($self, $val) = @_;
423 $self->{_in_storage} = $val if @_ > 1;
424 return $self->{_in_storage} ? 1 : 0;
429 $row->update(\%columns?)
433 =item Arguments: none or a hashref
435 =item Returns: The Row object
439 Throws an exception if the row object is not yet in the database,
440 according to L</in_storage>.
442 This method issues an SQL UPDATE query to commit any changes to the
443 object to the database if required (see L</get_dirty_columns>).
444 It throws an exception if a proper WHERE clause uniquely identifying
445 the database row can not be constructed (see
446 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
449 Also takes an optional hashref of C<< column_name => value> >> pairs
450 to update on the object first. Be aware that the hashref will be
451 passed to C<set_inflated_columns>, which might edit it in place, so
452 don't rely on it being the same after a call to C<update>. If you
453 need to preserve the hashref, it is sufficient to pass a shallow copy
454 to C<update>, e.g. ( { %{ $href } } )
456 If the values passed or any of the column values set on the object
457 contain scalar references, e.g.:
459 $row->last_modified(\'NOW()');
461 $row->update({ last_modified => \'NOW()' });
463 The update will pass the values verbatim into SQL. (See
464 L<SQL::Abstract> docs). The values in your Row object will NOT change
465 as a result of the update call, if you want the object to be updated
466 with the actual values from the database, call L</discard_changes>
469 $row->update()->discard_changes();
471 To determine before calling this method, which column values have
472 changed and will be updated, call L</get_dirty_columns>.
474 To check if any columns will be updated, call L</is_changed>.
476 To force a column to be updated, call L</make_column_dirty> before
482 my ($self, $upd) = @_;
483 $self->throw_exception( "Not in database" ) unless $self->in_storage;
485 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
487 $self->throw_exception('Unable to update a row with incomplete or no identity')
488 if ! keys %$ident_cond;
490 $self->set_inflated_columns($upd) if $upd;
491 my %to_update = $self->get_dirty_columns;
492 return $self unless keys %to_update;
493 my $rows = $self->result_source->storage->update(
494 $self->result_source, \%to_update, $ident_cond
497 $self->throw_exception( "Can't update ${self}: row not found" );
498 } elsif ($rows > 1) {
499 $self->throw_exception("Can't update ${self}: updated more than one row");
501 $self->{_dirty_columns} = {};
502 $self->{related_resultsets} = {};
503 delete $self->{_orig_ident};
513 =item Arguments: none
515 =item Returns: The Row object
519 Throws an exception if the object is not in the database according to
520 L</in_storage>. Also throws an exception if a proper WHERE clause
521 uniquely identifying the database row can not be constructed (see
522 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
525 The object is still perfectly usable, but L</in_storage> will
526 now return 0 and the object must be reinserted using L</insert>
527 before it can be used to L</update> the row again.
529 If you delete an object in a class with a C<has_many> relationship, an
530 attempt is made to delete all the related objects as well. To turn
531 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
532 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
533 database-level cascade or restrict will take precedence over a
534 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
535 main row first> and only then attempts to delete any remaining related
538 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
539 and the transaction subsequently fails, the row object will remain marked as
540 not being in storage. If you know for a fact that the object is still in
541 storage (i.e. by inspecting the cause of the transaction's failure), you can
542 use C<< $obj->in_storage(1) >> to restore consistency between the object and
543 the database. This would allow a subsequent C<< $obj->delete >> to work
546 See also L<DBIx::Class::ResultSet/delete>.
553 $self->throw_exception( "Not in database" ) unless $self->in_storage;
555 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
556 $self->throw_exception('Unable to delete a row with incomplete or no identity')
557 if ! keys %$ident_cond;
559 $self->result_source->storage->delete(
560 $self->result_source, $ident_cond
563 delete $self->{_orig_ident};
564 $self->in_storage(undef);
567 $self->throw_exception("Can't do class delete without a ResultSource instance")
568 unless $self->can('result_source_instance');
569 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
570 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
571 $self->result_source_instance->resultset->search(@_)->delete;
578 my $val = $row->get_column($col);
582 =item Arguments: $columnname
584 =item Returns: The value of the column
588 Throws an exception if the column name given doesn't exist according
591 Returns a raw column value from the row object, if it has already
592 been fetched from the database or set by an accessor.
594 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
595 will be deflated and returned.
597 Note that if you used the C<columns> or the C<select/as>
598 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
599 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
600 this method will return C<undef> even if the database contains some value.
602 To retrieve all loaded column values as a hash, use L</get_columns>.
607 my ($self, $column) = @_;
608 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
609 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
610 if (exists $self->{_inflated_column}{$column}) {
611 return $self->store_column($column,
612 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
614 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
618 =head2 has_column_loaded
620 if ( $row->has_column_loaded($col) ) {
621 print "$col has been loaded from db";
626 =item Arguments: $columnname
632 Returns a true value if the column value has been loaded from the
633 database (or set locally).
637 sub has_column_loaded {
638 my ($self, $column) = @_;
639 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
640 return 1 if exists $self->{_inflated_column}{$column};
641 return exists $self->{_column_data}{$column};
646 my %data = $row->get_columns;
650 =item Arguments: none
652 =item Returns: A hash of columnname, value pairs.
656 Returns all loaded column data as a hash, containing raw values. To
657 get just one value for a particular column, use L</get_column>.
659 See L</get_inflated_columns> to get the inflated values.
665 if (exists $self->{_inflated_column}) {
666 foreach my $col (keys %{$self->{_inflated_column}}) {
667 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
668 unless exists $self->{_column_data}{$col};
671 return %{$self->{_column_data}};
674 =head2 get_dirty_columns
676 my %data = $row->get_dirty_columns;
680 =item Arguments: none
682 =item Returns: A hash of column, value pairs
686 Only returns the column, value pairs for those columns that have been
687 changed on this object since the last L</update> or L</insert> call.
689 See L</get_columns> to fetch all column/value pairs.
693 sub get_dirty_columns {
695 return map { $_ => $self->{_column_data}{$_} }
696 keys %{$self->{_dirty_columns}};
699 =head2 make_column_dirty
701 $row->make_column_dirty($col)
705 =item Arguments: $columnname
707 =item Returns: undefined
711 Throws an exception if the column does not exist.
713 Marks a column as having been changed regardless of whether it has
717 sub make_column_dirty {
718 my ($self, $column) = @_;
720 $self->throw_exception( "No such column '${column}'" )
721 unless exists $self->{_column_data}{$column} || $self->has_column($column);
723 # the entire clean/dirty code relies on exists, not on true/false
724 return 1 if exists $self->{_dirty_columns}{$column};
726 $self->{_dirty_columns}{$column} = 1;
728 # if we are just now making the column dirty, and if there is an inflated
729 # value, force it over the deflated one
730 if (exists $self->{_inflated_column}{$column}) {
731 $self->store_column($column,
732 $self->_deflated_column(
733 $column, $self->{_inflated_column}{$column}
739 =head2 get_inflated_columns
741 my %inflated_data = $obj->get_inflated_columns;
745 =item Arguments: none
747 =item Returns: A hash of column, object|value pairs
751 Returns a hash of all column keys and associated values. Values for any
752 columns set to use inflation will be inflated and returns as objects.
754 See L</get_columns> to get the uninflated values.
756 See L<DBIx::Class::InflateColumn> for how to setup inflation.
760 sub get_inflated_columns {
763 my %loaded_colinfo = (map
764 { $_ => $self->column_info($_) }
765 (grep { $self->has_column_loaded($_) } $self->columns)
769 for my $col (keys %loaded_colinfo) {
770 if (exists $loaded_colinfo{$col}{accessor}) {
771 my $acc = $loaded_colinfo{$col}{accessor};
772 $inflated{$col} = $self->$acc if defined $acc;
775 $inflated{$col} = $self->$col;
779 # return all loaded columns with the inflations overlayed on top
780 return ($self->get_columns, %inflated);
783 sub _is_column_numeric {
784 my ($self, $column) = @_;
785 my $colinfo = $self->column_info ($column);
787 # cache for speed (the object may *not* have a resultsource instance)
788 if (not defined $colinfo->{is_numeric} && $self->_source_handle) {
789 $colinfo->{is_numeric} =
790 $self->result_source->schema->storage->is_datatype_numeric ($colinfo->{data_type})
796 return $colinfo->{is_numeric};
801 $row->set_column($col => $val);
805 =item Arguments: $columnname, $value
807 =item Returns: $value
811 Sets a raw column value. If the new value is different from the old one,
812 the column is marked as dirty for when you next call L</update>.
814 If passed an object or reference as a value, this method will happily
815 attempt to store it, and a later L</insert> or L</update> will try and
816 stringify/numify as appropriate. To set an object to be deflated
817 instead, see L</set_inflated_columns>.
822 my ($self, $column, $new_value) = @_;
824 # if we can't get an ident condition on first try - mark the object as unidentifiable
825 $self->{_orig_ident} ||= (eval { $self->ident_condition }) || {};
827 my $old_value = $self->get_column($column);
828 $new_value = $self->store_column($column, $new_value);
831 if (!$self->in_storage) { # no point tracking dirtyness on uninserted data
834 elsif (defined $old_value xor defined $new_value) {
837 elsif (not defined $old_value) { # both undef
840 elsif ($old_value eq $new_value) {
843 else { # do a numeric comparison if datatype allows it
844 if ($self->_is_column_numeric($column)) {
845 $dirty = $old_value != $new_value;
852 # sadly the update code just checks for keys, not for their value
853 $self->{_dirty_columns}{$column} = 1 if $dirty;
855 # XXX clear out the relation cache for this column
856 delete $self->{related_resultsets}{$column};
863 $row->set_columns({ $col => $val, ... });
867 =item Arguments: \%columndata
869 =item Returns: The Row object
873 Sets multiple column, raw value pairs at once.
875 Works as L</set_column>.
880 my ($self,$data) = @_;
881 foreach my $col (keys %$data) {
882 $self->set_column($col,$data->{$col});
887 =head2 set_inflated_columns
889 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
893 =item Arguments: \%columndata
895 =item Returns: The Row object
899 Sets more than one column value at once. Any inflated values are
900 deflated and the raw values stored.
902 Any related values passed as Row objects, using the relation name as a
903 key, are reduced to the appropriate foreign key values and stored. If
904 instead of related row objects, a hashref of column, value data is
905 passed, will create the related object first then store.
907 Will even accept arrayrefs of data as a value to a
908 L<DBIx::Class::Relationship/has_many> key, and create the related
909 objects if necessary.
911 Be aware that the input hashref might be edited in place, so don't rely
912 on it being the same after a call to C<set_inflated_columns>. If you
913 need to preserve the hashref, it is sufficient to pass a shallow copy
914 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
916 See also L<DBIx::Class::Relationship::Base/set_from_related>.
920 sub set_inflated_columns {
921 my ( $self, $upd ) = @_;
922 foreach my $key (keys %$upd) {
923 if (ref $upd->{$key}) {
924 my $info = $self->relationship_info($key);
925 my $acc_type = $info->{attrs}{accessor} || '';
926 if ($acc_type eq 'single') {
927 my $rel = delete $upd->{$key};
928 $self->set_from_related($key => $rel);
929 $self->{_relationship_data}{$key} = $rel;
931 elsif ($acc_type eq 'multi') {
932 $self->throw_exception(
933 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
936 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
937 $self->set_inflated_column($key, delete $upd->{$key});
941 $self->set_columns($upd);
946 my $copy = $orig->copy({ change => $to, ... });
950 =item Arguments: \%replacementdata
952 =item Returns: The Row object copy
956 Inserts a new row into the database, as a copy of the original
957 object. If a hashref of replacement data is supplied, these will take
958 precedence over data in the original. Also any columns which have
959 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
960 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
961 so that the database can insert its own autoincremented values into
964 Relationships will be followed by the copy procedure B<only> if the
965 relationship specifies a true value for its
966 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
967 is set by default on C<has_many> relationships and unset on all others.
972 my ($self, $changes) = @_;
974 my $col_data = { %{$self->{_column_data}} };
975 foreach my $col (keys %$col_data) {
976 delete $col_data->{$col}
977 if $self->result_source->column_info($col)->{is_auto_increment};
980 my $new = { _column_data => $col_data };
981 bless $new, ref $self;
983 $new->result_source($self->result_source);
984 $new->set_inflated_columns($changes);
987 # Its possible we'll have 2 relations to the same Source. We need to make
988 # sure we don't try to insert the same row twice else we'll violate unique
990 my $rels_copied = {};
992 foreach my $rel ($self->result_source->relationships) {
993 my $rel_info = $self->result_source->relationship_info($rel);
995 next unless $rel_info->{attrs}{cascade_copy};
997 my $resolved = $self->result_source->_resolve_condition(
998 $rel_info->{cond}, $rel, $new
1001 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1002 foreach my $related ($self->search_related($rel)) {
1003 my $id_str = join("\0", $related->id);
1004 next if $copied->{$id_str};
1005 $copied->{$id_str} = 1;
1006 my $rel_copy = $related->copy($resolved);
1015 $row->store_column($col => $val);
1019 =item Arguments: $columnname, $value
1021 =item Returns: The value sent to storage
1025 Set a raw value for a column without marking it as changed. This
1026 method is used internally by L</set_column> which you should probably
1029 This is the lowest level at which data is set on a row object,
1030 extend this method to catch all data setting methods.
1035 my ($self, $column, $value) = @_;
1036 $self->throw_exception( "No such column '${column}'" )
1037 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1038 $self->throw_exception( "set_column called for ${column} without value" )
1040 return $self->{_column_data}{$column} = $value;
1043 =head2 inflate_result
1045 Class->inflate_result($result_source, \%me, \%prefetch?)
1049 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1051 =item Returns: A Row object
1055 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1056 database and turn it into row objects call this method.
1058 Extend this method in your Result classes to hook into this process,
1059 for example to rebless the result into a different class.
1061 Reblessing can also be done more easily by setting C<result_class> in
1062 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1064 Different types of results can also be created from a particular
1065 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1069 sub inflate_result {
1070 my ($class, $source, $me, $prefetch) = @_;
1072 my ($source_handle) = $source;
1074 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
1075 $source = $source_handle->resolve
1078 $source_handle = $source->handle
1082 _source_handle => $source_handle,
1083 _column_data => $me,
1085 bless $new, (ref $class || $class);
1087 foreach my $pre (keys %{$prefetch||{}}) {
1089 my $pre_source = $source->related_source($pre)
1090 or $class->throw_exception("Can't prefetch non-existent relationship ${pre}");
1092 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1093 or $class->throw_exception("No accessor for prefetched $pre");
1096 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1097 @pre_vals = @{$prefetch->{$pre}};
1099 elsif ($accessor eq 'multi') {
1100 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor 'multi'");
1103 @pre_vals = $prefetch->{$pre};
1107 for my $me_pref (@pre_vals) {
1109 # FIXME - this should not be necessary
1110 # the collapser currently *could* return bogus elements with all
1111 # columns set to undef
1113 for (values %{$me_pref->[0]}) {
1119 next unless $has_def;
1121 push @pre_objects, $pre_source->result_class->inflate_result(
1122 $pre_source, @$me_pref
1126 if ($accessor eq 'single') {
1127 $new->{_relationship_data}{$pre} = $pre_objects[0];
1129 elsif ($accessor eq 'filter') {
1130 $new->{_inflated_column}{$pre} = $pre_objects[0];
1133 $new->related_resultset($pre)->set_cache(\@pre_objects);
1136 $new->in_storage (1);
1140 =head2 update_or_insert
1142 $row->update_or_insert
1146 =item Arguments: none
1148 =item Returns: Result of update or insert operation
1152 L</Update>s the object if it's already in the database, according to
1153 L</in_storage>, else L</insert>s it.
1155 =head2 insert_or_update
1157 $obj->insert_or_update
1159 Alias for L</update_or_insert>
1163 sub insert_or_update { shift->update_or_insert(@_) }
1165 sub update_or_insert {
1167 return ($self->in_storage ? $self->update : $self->insert);
1172 my @changed_col_names = $row->is_changed();
1173 if ($row->is_changed()) { ... }
1177 =item Arguments: none
1179 =item Returns: 0|1 or @columnnames
1183 In list context returns a list of columns with uncommited changes, or
1184 in scalar context returns a true value if there are uncommitted
1190 return keys %{shift->{_dirty_columns} || {}};
1193 =head2 is_column_changed
1195 if ($row->is_column_changed('col')) { ... }
1199 =item Arguments: $columname
1205 Returns a true value if the column has uncommitted changes.
1209 sub is_column_changed {
1210 my( $self, $col ) = @_;
1211 return exists $self->{_dirty_columns}->{$col};
1214 =head2 result_source
1216 my $resultsource = $row->result_source;
1220 =item Arguments: none
1222 =item Returns: a ResultSource instance
1226 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1234 $self->_source_handle($_[0]->handle);
1236 $self->_source_handle->resolve;
1240 =head2 register_column
1242 $column_info = { .... };
1243 $class->register_column($column_name, $column_info);
1247 =item Arguments: $columnname, \%columninfo
1249 =item Returns: undefined
1253 Registers a column on the class. If the column_info has an 'accessor'
1254 key, creates an accessor named after the value if defined; if there is
1255 no such key, creates an accessor with the same name as the column
1257 The column_info attributes are described in
1258 L<DBIx::Class::ResultSource/add_columns>
1262 sub register_column {
1263 my ($class, $col, $info) = @_;
1265 if (exists $info->{accessor}) {
1266 return unless defined $info->{accessor};
1267 $acc = [ $info->{accessor}, $col ];
1269 $class->mk_group_accessors('column' => $acc);
1272 =head2 get_from_storage
1274 my $copy = $row->get_from_storage($attrs)
1278 =item Arguments: \%attrs
1280 =item Returns: A Row object
1284 Fetches a fresh copy of the Row object from the database and returns it.
1285 Throws an exception if a proper WHERE clause identifying the database row
1286 can not be constructed (i.e. if the original object does not contain its
1288 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1289 ). If passed the \%attrs argument, will first apply these attributes to
1290 the resultset used to find the row.
1292 This copy can then be used to compare to an existing row object, to
1293 determine if any changes have been made in the database since it was
1296 To just update your Row object with any latest changes from the
1297 database, use L</discard_changes> instead.
1299 The \%attrs argument should be compatible with
1300 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1304 sub get_from_storage {
1305 my $self = shift @_;
1306 my $attrs = shift @_;
1307 my $resultset = $self->result_source->resultset;
1309 if(defined $attrs) {
1310 $resultset = $resultset->search(undef, $attrs);
1313 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
1315 $self->throw_exception('Unable to requery a row with incomplete or no identity')
1316 if ! keys %$ident_cond;
1318 return $resultset->find($ident_cond);
1321 =head2 discard_changes ($attrs)
1323 Re-selects the row from the database, losing any changes that had
1324 been made. Throws an exception if a proper WHERE clause identifying
1325 the database row can not be constructed (i.e. if the original object
1326 does not contain its entire
1327 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1330 This method can also be used to refresh from storage, retrieving any
1331 changes made since the row was last read from storage.
1333 $attrs is expected to be a hashref of attributes suitable for passing as the
1334 second argument to $resultset->search($cond, $attrs);
1338 sub discard_changes {
1339 my ($self, $attrs) = @_;
1340 delete $self->{_dirty_columns};
1341 return unless $self->in_storage; # Don't reload if we aren't real!
1343 # add a replication default to read from the master only
1344 $attrs = { force_pool => 'master', %{$attrs||{}} };
1346 if( my $current_storage = $self->get_from_storage($attrs)) {
1348 # Set $self to the current.
1349 %$self = %$current_storage;
1351 # Avoid a possible infinite loop with
1352 # sub DESTROY { $_[0]->discard_changes }
1353 bless $current_storage, 'Do::Not::Exist';
1358 $self->in_storage(0);
1364 =head2 throw_exception
1366 See L<DBIx::Class::Schema/throw_exception>.
1370 sub throw_exception {
1373 if (ref $self && ref $self->result_source && $self->result_source->schema) {
1374 $self->result_source->schema->throw_exception(@_)
1377 DBIx::Class::Exception->throw(@_);
1387 =item Arguments: none
1389 =item Returns: A list of primary key values
1393 Returns the primary key(s) for a row. Can't be called as a class method.
1394 Actually implemented in L<DBIx::Class::PK>
1396 =head2 discard_changes
1398 $row->discard_changes
1402 =item Arguments: none
1404 =item Returns: nothing (updates object in-place)
1408 Retrieves and sets the row object data from the database, losing any
1411 This method can also be used to refresh from storage, retrieving any
1412 changes made since the row was last read from storage. Actually
1413 implemented in L<DBIx::Class::PK>
1415 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1416 storage, please kept in mind that if you L</discard_changes> on a row that you
1417 just updated or created, you should wrap the entire bit inside a transaction.
1418 Otherwise you run the risk that you insert or update to the master database
1419 but read from a replicant database that has not yet been updated from the
1420 master. This will result in unexpected results.
1428 Matt S. Trout <mst@shadowcatsystems.co.uk>
1432 You may distribute this code under the same terms as Perl itself.