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 if ($info && $info->{attrs}{accessor}
175 && $info->{attrs}{accessor} eq 'single')
177 my $rel_obj = delete $attrs->{$key};
178 if(!Scalar::Util::blessed($rel_obj)) {
179 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
182 if ($rel_obj->in_storage) {
183 $new->{_rel_in_storage}{$key} = 1;
184 $new->set_from_related($key, $rel_obj);
186 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj\n";
189 $related->{$key} = $rel_obj;
191 } elsif ($info && $info->{attrs}{accessor}
192 && $info->{attrs}{accessor} eq 'multi'
193 && ref $attrs->{$key} eq 'ARRAY') {
194 my $others = delete $attrs->{$key};
195 my $total = @$others;
197 foreach my $idx (0 .. $#$others) {
198 my $rel_obj = $others->[$idx];
199 if(!Scalar::Util::blessed($rel_obj)) {
200 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
203 if ($rel_obj->in_storage) {
204 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
206 MULTICREATE_DEBUG and
207 warn "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
209 push(@objects, $rel_obj);
211 $related->{$key} = \@objects;
213 } elsif ($info && $info->{attrs}{accessor}
214 && $info->{attrs}{accessor} eq 'filter')
216 ## 'filter' should disappear and get merged in with 'single' above!
217 my $rel_obj = delete $attrs->{$key};
218 if(!Scalar::Util::blessed($rel_obj)) {
219 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
221 if ($rel_obj->in_storage) {
222 $new->{_rel_in_storage}{$key} = 1;
225 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj";
227 $inflated->{$key} = $rel_obj;
229 } elsif ($class->has_column($key)
230 && $class->column_info($key)->{_inflate_info}) {
231 $inflated->{$key} = $attrs->{$key};
235 $new->throw_exception("No such column $key on $class")
236 unless $class->has_column($key);
237 $new->store_column($key => $attrs->{$key});
240 $new->{_relationship_data} = $related if $related;
241 $new->{_inflated_column} = $inflated if $inflated;
253 =item Arguments: none
255 =item Returns: The Row object
259 Inserts an object previously created by L</new> into the database if
260 it isn't already in there. Returns the object itself. Requires the
261 object's result source to be set, or the class to have a
262 result_source_instance method. To insert an entirely new row into
263 the database, use C<create> (see L<DBIx::Class::ResultSet/create>).
265 To fetch an uninserted row object, call
266 L<new|DBIx::Class::ResultSet/new> on a resultset.
268 This will also insert any uninserted, related objects held inside this
269 one, see L<DBIx::Class::ResultSet/create> for more details.
275 return $self if $self->in_storage;
276 my $source = $self->result_source;
277 $source ||= $self->result_source($self->result_source_instance)
278 if $self->can('result_source_instance');
279 $self->throw_exception("No result_source set on this object; can't insert")
284 # Check if we stored uninserted relobjs here in new()
285 my %related_stuff = (%{$self->{_relationship_data} || {}},
286 %{$self->{_inflated_column} || {}});
288 # insert what needs to be inserted before us
290 for my $relname (keys %related_stuff) {
291 my $rel_obj = $related_stuff{$relname};
293 if (! $self->{_rel_in_storage}{$relname}) {
294 next unless (Scalar::Util::blessed($rel_obj)
295 && $rel_obj->isa('DBIx::Class::Row'));
297 next unless $source->_pk_depends_on(
298 $relname, { $rel_obj->get_columns }
301 # The guard will save us if we blow out of this scope via die
302 $rollback_guard ||= $source->storage->txn_scope_guard;
304 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
306 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_inflated_columns };
307 my $re = $self->result_source
308 ->related_source($relname)
310 ->find_or_create($them);
312 %{$rel_obj} = %{$re};
313 $self->{_rel_in_storage}{$relname} = 1;
316 $self->set_from_related($relname, $rel_obj);
317 delete $related_stuff{$relname};
320 # start a transaction here if not started yet and there is more stuff
322 if (keys %related_stuff) {
323 $rollback_guard ||= $source->storage->txn_scope_guard
326 MULTICREATE_DEBUG and do {
327 no warnings 'uninitialized';
328 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
330 my $updated_cols = $source->storage->insert($source, { $self->get_columns });
331 foreach my $col (keys %$updated_cols) {
332 $self->store_column($col, $updated_cols->{$col});
336 my @auto_pri = grep {
337 (not defined $self->get_column($_))
339 (ref($self->get_column($_)) eq 'SCALAR')
340 } $self->primary_columns;
343 MULTICREATE_DEBUG and warn "MC $self fetching missing PKs ".join(', ', @auto_pri)."\n";
344 my $storage = $self->result_source->storage;
345 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
346 unless $storage->can('last_insert_id');
347 my @ids = $storage->last_insert_id($self->result_source,@auto_pri);
348 $self->throw_exception( "Can't get last insert id" )
349 unless (@ids == @auto_pri);
350 $self->store_column($auto_pri[$_] => $ids[$_]) for 0 .. $#ids;
354 $self->{_dirty_columns} = {};
355 $self->{related_resultsets} = {};
357 foreach my $relname (keys %related_stuff) {
358 next unless $source->has_relationship ($relname);
360 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
361 ? @{$related_stuff{$relname}}
362 : $related_stuff{$relname}
366 && Scalar::Util::blessed($cands[0])
367 && $cands[0]->isa('DBIx::Class::Row')
369 my $reverse = $source->reverse_relationship_info($relname);
370 foreach my $obj (@cands) {
371 $obj->set_from_related($_, $self) for keys %$reverse;
372 my $them = { %{$obj->{_relationship_data} || {} }, $obj->get_inflated_columns };
373 if ($self->__their_pk_needs_us($relname, $them)) {
374 if (exists $self->{_ignore_at_insert}{$relname}) {
375 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
377 MULTICREATE_DEBUG and warn "MC $self re-creating $relname $obj";
378 my $re = $self->result_source
379 ->related_source($relname)
383 MULTICREATE_DEBUG and warn "MC $self new $relname $obj";
386 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
393 $self->in_storage(1);
394 delete $self->{_orig_ident};
395 delete $self->{_ignore_at_insert};
396 $rollback_guard->commit if $rollback_guard;
403 $row->in_storage; # Get value
404 $row->in_storage(1); # Set value
408 =item Arguments: none or 1|0
414 Indicates whether the object exists as a row in the database or
415 not. This is set to true when L<DBIx::Class::ResultSet/find>,
416 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
419 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
420 L</delete> on one, sets it to false.
425 my ($self, $val) = @_;
426 $self->{_in_storage} = $val if @_ > 1;
427 return $self->{_in_storage} ? 1 : 0;
432 $row->update(\%columns?)
436 =item Arguments: none or a hashref
438 =item Returns: The Row object
442 Throws an exception if the row object is not yet in the database,
443 according to L</in_storage>.
445 This method issues an SQL UPDATE query to commit any changes to the
446 object to the database if required (see L</get_dirty_columns>).
447 It throws an exception if a proper WHERE clause uniquely identifying
448 the database row can not be constructed (see
449 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
452 Also takes an optional hashref of C<< column_name => value> >> pairs
453 to update on the object first. Be aware that the hashref will be
454 passed to C<set_inflated_columns>, which might edit it in place, so
455 don't rely on it being the same after a call to C<update>. If you
456 need to preserve the hashref, it is sufficient to pass a shallow copy
457 to C<update>, e.g. ( { %{ $href } } )
459 If the values passed or any of the column values set on the object
460 contain scalar references, eg:
462 $row->last_modified(\'NOW()');
464 $row->update({ last_modified => \'NOW()' });
466 The update will pass the values verbatim into SQL. (See
467 L<SQL::Abstract> docs). The values in your Row object will NOT change
468 as a result of the update call, if you want the object to be updated
469 with the actual values from the database, call L</discard_changes>
472 $row->update()->discard_changes();
474 To determine before calling this method, which column values have
475 changed and will be updated, call L</get_dirty_columns>.
477 To check if any columns will be updated, call L</is_changed>.
479 To force a column to be updated, call L</make_column_dirty> before
485 my ($self, $upd) = @_;
486 $self->throw_exception( "Not in database" ) unless $self->in_storage;
487 my $ident_cond = $self->ident_condition;
488 $self->throw_exception("Cannot safely update a row in a PK-less table")
489 if ! keys %$ident_cond;
491 $self->set_inflated_columns($upd) if $upd;
492 my %to_update = $self->get_dirty_columns;
493 return $self unless keys %to_update;
494 my $rows = $self->result_source->storage->update(
495 $self->result_source, \%to_update,
496 $self->{_orig_ident} || $ident_cond
499 $self->throw_exception( "Can't update ${self}: row not found" );
500 } elsif ($rows > 1) {
501 $self->throw_exception("Can't update ${self}: updated more than one row");
503 $self->{_dirty_columns} = {};
504 $self->{related_resultsets} = {};
505 undef $self->{_orig_ident};
515 =item Arguments: none
517 =item Returns: The Row object
521 Throws an exception if the object is not in the database according to
522 L</in_storage>. Also throws an exception if a proper WHERE clause
523 uniquely identifying the database row can not be constructed (see
524 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
527 The object is still perfectly usable, but L</in_storage> will
528 now return 0 and the object must be reinserted using L</insert>
529 before it can be used to L</update> the row again.
531 If you delete an object in a class with a C<has_many> relationship, an
532 attempt is made to delete all the related objects as well. To turn
533 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
534 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
535 database-level cascade or restrict will take precedence over a
536 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
537 main row first> and only then attempts to delete any remaining related
540 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
541 and the transaction subsequently fails, the row object will remain marked as
542 not being in storage. If you know for a fact that the object is still in
543 storage (i.e. by inspecting the cause of the transaction's failure), you can
544 use C<< $obj->in_storage(1) >> to restore consistency between the object and
545 the database. This would allow a subsequent C<< $obj->delete >> to work
548 See also L<DBIx::Class::ResultSet/delete>.
555 $self->throw_exception( "Not in database" ) unless $self->in_storage;
556 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
557 $self->throw_exception("Cannot safely delete a row in a PK-less table")
558 if ! keys %$ident_cond;
559 foreach my $column (keys %$ident_cond) {
560 $self->throw_exception("Can't delete the object unless it has loaded the primary keys")
561 unless exists $self->{_column_data}{$column};
563 $self->result_source->storage->delete(
564 $self->result_source, $ident_cond);
565 $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};
773 $inflated{$col} = $self->$acc;
777 $inflated{$col} = $self->$col;
781 # return all loaded columns with the inflations overlayed on top
782 return ($self->get_columns, %inflated);
785 sub _is_column_numeric {
786 my ($self, $column) = @_;
787 my $colinfo = $self->column_info ($column);
789 # cache for speed (the object may *not* have a resultsource instance)
790 if (not defined $colinfo->{is_numeric} && $self->_source_handle) {
791 $colinfo->{is_numeric} =
792 $self->result_source->schema->storage->is_datatype_numeric ($colinfo->{data_type})
798 return $colinfo->{is_numeric};
803 $row->set_column($col => $val);
807 =item Arguments: $columnname, $value
809 =item Returns: $value
813 Sets a raw column value. If the new value is different from the old one,
814 the column is marked as dirty for when you next call L</update>.
816 If passed an object or reference as a value, this method will happily
817 attempt to store it, and a later L</insert> or L</update> will try and
818 stringify/numify as appropriate. To set an object to be deflated
819 instead, see L</set_inflated_columns>.
824 my ($self, $column, $new_value) = @_;
826 $self->{_orig_ident} ||= $self->ident_condition;
827 my $old_value = $self->get_column($column);
829 $new_value = $self->store_column($column, $new_value);
832 if (!$self->in_storage) { # no point tracking dirtyness on uninserted data
835 elsif (defined $old_value xor defined $new_value) {
838 elsif (not defined $old_value) { # both undef
841 elsif ($old_value eq $new_value) {
844 else { # do a numeric comparison if datatype allows it
845 if ($self->_is_column_numeric($column)) {
846 $dirty = $old_value != $new_value;
853 # sadly the update code just checks for keys, not for their value
854 $self->{_dirty_columns}{$column} = 1 if $dirty;
856 # XXX clear out the relation cache for this column
857 delete $self->{related_resultsets}{$column};
864 $row->set_columns({ $col => $val, ... });
868 =item Arguments: \%columndata
870 =item Returns: The Row object
874 Sets multiple column, raw value pairs at once.
876 Works as L</set_column>.
881 my ($self,$data) = @_;
882 foreach my $col (keys %$data) {
883 $self->set_column($col,$data->{$col});
888 =head2 set_inflated_columns
890 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
894 =item Arguments: \%columndata
896 =item Returns: The Row object
900 Sets more than one column value at once. Any inflated values are
901 deflated and the raw values stored.
903 Any related values passed as Row objects, using the relation name as a
904 key, are reduced to the appropriate foreign key values and stored. If
905 instead of related row objects, a hashref of column, value data is
906 passed, will create the related object first then store.
908 Will even accept arrayrefs of data as a value to a
909 L<DBIx::Class::Relationship/has_many> key, and create the related
910 objects if necessary.
912 Be aware that the input hashref might be edited in place, so dont rely
913 on it being the same after a call to C<set_inflated_columns>. If you
914 need to preserve the hashref, it is sufficient to pass a shallow copy
915 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
917 See also L<DBIx::Class::Relationship::Base/set_from_related>.
921 sub set_inflated_columns {
922 my ( $self, $upd ) = @_;
923 foreach my $key (keys %$upd) {
924 if (ref $upd->{$key}) {
925 my $info = $self->relationship_info($key);
926 if ($info && $info->{attrs}{accessor}
927 && $info->{attrs}{accessor} eq 'single')
929 my $rel = delete $upd->{$key};
930 $self->set_from_related($key => $rel);
931 $self->{_relationship_data}{$key} = $rel;
932 } elsif ($info && $info->{attrs}{accessor}
933 && $info->{attrs}{accessor} eq 'multi') {
934 $self->throw_exception(
935 "Recursive update is not supported over relationships of type multi ($key)"
938 elsif ($self->has_column($key)
939 && exists $self->column_info($key)->{_inflate_info})
941 $self->set_inflated_column($key, delete $upd->{$key});
945 $self->set_columns($upd);
950 my $copy = $orig->copy({ change => $to, ... });
954 =item Arguments: \%replacementdata
956 =item Returns: The Row object copy
960 Inserts a new row into the database, as a copy of the original
961 object. If a hashref of replacement data is supplied, these will take
962 precedence over data in the original. Also any columns which have
963 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
964 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
965 so that the database can insert its own autoincremented values into
968 Relationships will be followed by the copy procedure B<only> if the
969 relationship specifes a true value for its
970 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
971 is set by default on C<has_many> relationships and unset on all others.
976 my ($self, $changes) = @_;
978 my $col_data = { %{$self->{_column_data}} };
979 foreach my $col (keys %$col_data) {
980 delete $col_data->{$col}
981 if $self->result_source->column_info($col)->{is_auto_increment};
984 my $new = { _column_data => $col_data };
985 bless $new, ref $self;
987 $new->result_source($self->result_source);
988 $new->set_inflated_columns($changes);
991 # Its possible we'll have 2 relations to the same Source. We need to make
992 # sure we don't try to insert the same row twice esle we'll violate unique
994 my $rels_copied = {};
996 foreach my $rel ($self->result_source->relationships) {
997 my $rel_info = $self->result_source->relationship_info($rel);
999 next unless $rel_info->{attrs}{cascade_copy};
1001 my $resolved = $self->result_source->_resolve_condition(
1002 $rel_info->{cond}, $rel, $new
1005 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1006 foreach my $related ($self->search_related($rel)) {
1007 my $id_str = join("\0", $related->id);
1008 next if $copied->{$id_str};
1009 $copied->{$id_str} = 1;
1010 my $rel_copy = $related->copy($resolved);
1019 $row->store_column($col => $val);
1023 =item Arguments: $columnname, $value
1025 =item Returns: The value sent to storage
1029 Set a raw value for a column without marking it as changed. This
1030 method is used internally by L</set_column> which you should probably
1033 This is the lowest level at which data is set on a row object,
1034 extend this method to catch all data setting methods.
1039 my ($self, $column, $value) = @_;
1040 $self->throw_exception( "No such column '${column}'" )
1041 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1042 $self->throw_exception( "set_column called for ${column} without value" )
1044 return $self->{_column_data}{$column} = $value;
1047 =head2 inflate_result
1049 Class->inflate_result($result_source, \%me, \%prefetch?)
1053 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1055 =item Returns: A Row object
1059 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1060 database and turn it into row objects call this method.
1062 Extend this method in your Result classes to hook into this process,
1063 for example to rebless the result into a different class.
1065 Reblessing can also be done more easily by setting C<result_class> in
1066 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1068 Different types of results can also be created from a particular
1069 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1073 sub inflate_result {
1074 my ($class, $source, $me, $prefetch) = @_;
1076 my ($source_handle) = $source;
1078 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
1079 $source = $source_handle->resolve
1081 $source_handle = $source->handle
1085 _source_handle => $source_handle,
1086 _column_data => $me,
1088 bless $new, (ref $class || $class);
1091 foreach my $pre (keys %{$prefetch||{}}) {
1092 my $pre_val = $prefetch->{$pre};
1093 my $pre_source = $source->related_source($pre);
1094 $class->throw_exception("Can't prefetch non-existent relationship ${pre}")
1096 if (ref($pre_val->[0]) eq 'ARRAY') { # multi
1099 for my $me_pref (@$pre_val) {
1101 # the collapser currently *could* return bogus elements with all
1102 # columns set to undef
1104 for (values %{$me_pref->[0]}) {
1110 next unless $has_def;
1112 push @pre_objects, $pre_source->result_class->inflate_result(
1113 $pre_source, @$me_pref
1117 $new->related_resultset($pre)->set_cache(\@pre_objects);
1118 } elsif (defined $pre_val->[0]) {
1120 unless ($pre_source->primary_columns == grep { exists $pre_val->[0]{$_}
1121 and !defined $pre_val->[0]{$_} } $pre_source->primary_columns)
1123 $fetched = $pre_source->result_class->inflate_result(
1124 $pre_source, @{$pre_val});
1126 my $accessor = $source->relationship_info($pre)->{attrs}{accessor};
1127 $class->throw_exception("No accessor for prefetched $pre")
1128 unless defined $accessor;
1129 if ($accessor eq 'single') {
1130 $new->{_relationship_data}{$pre} = $fetched;
1131 } elsif ($accessor eq 'filter') {
1132 $new->{_inflated_column}{$pre} = $fetched;
1134 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor '$accessor'");
1136 $new->related_resultset($pre)->set_cache([ $fetched ]);
1140 $new->in_storage (1);
1144 =head2 update_or_insert
1146 $row->update_or_insert
1150 =item Arguments: none
1152 =item Returns: Result of update or insert operation
1156 L</Update>s the object if it's already in the database, according to
1157 L</in_storage>, else L</insert>s it.
1159 =head2 insert_or_update
1161 $obj->insert_or_update
1163 Alias for L</update_or_insert>
1167 sub insert_or_update { shift->update_or_insert(@_) }
1169 sub update_or_insert {
1171 return ($self->in_storage ? $self->update : $self->insert);
1176 my @changed_col_names = $row->is_changed();
1177 if ($row->is_changed()) { ... }
1181 =item Arguments: none
1183 =item Returns: 0|1 or @columnnames
1187 In list context returns a list of columns with uncommited changes, or
1188 in scalar context returns a true value if there are uncommitted
1194 return keys %{shift->{_dirty_columns} || {}};
1197 =head2 is_column_changed
1199 if ($row->is_column_changed('col')) { ... }
1203 =item Arguments: $columname
1209 Returns a true value if the column has uncommitted changes.
1213 sub is_column_changed {
1214 my( $self, $col ) = @_;
1215 return exists $self->{_dirty_columns}->{$col};
1218 =head2 result_source
1220 my $resultsource = $row->result_source;
1224 =item Arguments: none
1226 =item Returns: a ResultSource instance
1230 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1238 $self->_source_handle($_[0]->handle);
1240 $self->_source_handle->resolve;
1244 =head2 register_column
1246 $column_info = { .... };
1247 $class->register_column($column_name, $column_info);
1251 =item Arguments: $columnname, \%columninfo
1253 =item Returns: undefined
1257 Registers a column on the class. If the column_info has an 'accessor'
1258 key, creates an accessor named after the value if defined; if there is
1259 no such key, creates an accessor with the same name as the column
1261 The column_info attributes are described in
1262 L<DBIx::Class::ResultSource/add_columns>
1266 sub register_column {
1267 my ($class, $col, $info) = @_;
1269 if (exists $info->{accessor}) {
1270 return unless defined $info->{accessor};
1271 $acc = [ $info->{accessor}, $col ];
1273 $class->mk_group_accessors('column' => $acc);
1276 =head2 get_from_storage
1278 my $copy = $row->get_from_storage($attrs)
1282 =item Arguments: \%attrs
1284 =item Returns: A Row object
1288 Fetches a fresh copy of the Row object from the database and returns it.
1289 Throws an exception if a proper WHERE clause identifying the database row
1290 can not be constructed (i.e. if the original object does not contain its
1292 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1293 ). If passed the \%attrs argument, will first apply these attributes to
1294 the resultset used to find the row.
1296 This copy can then be used to compare to an existing row object, to
1297 determine if any changes have been made in the database since it was
1300 To just update your Row object with any latest changes from the
1301 database, use L</discard_changes> instead.
1303 The \%attrs argument should be compatible with
1304 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1308 sub get_from_storage {
1309 my $self = shift @_;
1310 my $attrs = shift @_;
1311 my $resultset = $self->result_source->resultset;
1313 if(defined $attrs) {
1314 $resultset = $resultset->search(undef, $attrs);
1317 return $resultset->find($self->{_orig_ident} || $self->ident_condition);
1320 =head2 discard_changes ($attrs)
1322 Re-selects the row from the database, losing any changes that had
1323 been made. Throws an exception if a proper WHERE clause identifying
1324 the database row can not be constructed (i.e. if the original object
1325 does not contain its entire
1326 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1329 This method can also be used to refresh from storage, retrieving any
1330 changes made since the row was last read from storage.
1332 $attrs is expected to be a hashref of attributes suitable for passing as the
1333 second argument to $resultset->search($cond, $attrs);
1337 sub discard_changes {
1338 my ($self, $attrs) = @_;
1339 delete $self->{_dirty_columns};
1340 return unless $self->in_storage; # Don't reload if we aren't real!
1342 # add a replication default to read from the master only
1343 $attrs = { force_pool => 'master', %{$attrs||{}} };
1345 if( my $current_storage = $self->get_from_storage($attrs)) {
1347 # Set $self to the current.
1348 %$self = %$current_storage;
1350 # Avoid a possible infinite loop with
1351 # sub DESTROY { $_[0]->discard_changes }
1352 bless $current_storage, 'Do::Not::Exist';
1357 $self->in_storage(0);
1363 =head2 throw_exception
1365 See L<DBIx::Class::Schema/throw_exception>.
1369 sub throw_exception {
1372 if (ref $self && ref $self->result_source && $self->result_source->schema) {
1373 $self->result_source->schema->throw_exception(@_)
1376 DBIx::Class::Exception->throw(@_);
1386 =item Arguments: none
1388 =item Returns: A list of primary key values
1392 Returns the primary key(s) for a row. Can't be called as a class method.
1393 Actually implemented in L<DBIx::Class::PK>
1395 =head2 discard_changes
1397 $row->discard_changes
1401 =item Arguments: none
1403 =item Returns: nothing (updates object in-place)
1407 Retrieves and sets the row object data from the database, losing any
1410 This method can also be used to refresh from storage, retrieving any
1411 changes made since the row was last read from storage. Actually
1412 implemented in L<DBIx::Class::PK>
1414 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1415 storage, please kept in mind that if you L</discard_changes> on a row that you
1416 just updated or created, you should wrap the entire bit inside a transaction.
1417 Otherwise you run the risk that you insert or update to the master database
1418 but read from a replicant database that has not yet been updated from the
1419 master. This will result in unexpected results.
1427 Matt S. Trout <mst@shadowcatsystems.co.uk>
1431 You may distribute this code under the same terms as Perl itself.