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;
350 $self->{_dirty_columns} = {};
351 $self->{related_resultsets} = {};
353 foreach my $relname (keys %related_stuff) {
354 next unless $source->has_relationship ($relname);
356 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
357 ? @{$related_stuff{$relname}}
358 : $related_stuff{$relname}
362 && Scalar::Util::blessed($cands[0])
363 && $cands[0]->isa('DBIx::Class::Row')
365 my $reverse = $source->reverse_relationship_info($relname);
366 foreach my $obj (@cands) {
367 $obj->set_from_related($_, $self) for keys %$reverse;
368 my $them = { %{$obj->{_relationship_data} || {} }, $obj->get_inflated_columns };
369 if ($self->__their_pk_needs_us($relname, $them)) {
370 if (exists $self->{_ignore_at_insert}{$relname}) {
371 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
373 MULTICREATE_DEBUG and warn "MC $self re-creating $relname $obj";
374 my $re = $self->result_source
375 ->related_source($relname)
379 MULTICREATE_DEBUG and warn "MC $self new $relname $obj";
382 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
389 $self->in_storage(1);
390 delete $self->{_orig_ident};
391 delete $self->{_ignore_at_insert};
392 $rollback_guard->commit if $rollback_guard;
399 $row->in_storage; # Get value
400 $row->in_storage(1); # Set value
404 =item Arguments: none or 1|0
410 Indicates whether the object exists as a row in the database or
411 not. This is set to true when L<DBIx::Class::ResultSet/find>,
412 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
415 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
416 L</delete> on one, sets it to false.
421 my ($self, $val) = @_;
422 $self->{_in_storage} = $val if @_ > 1;
423 return $self->{_in_storage} ? 1 : 0;
428 $row->update(\%columns?)
432 =item Arguments: none or a hashref
434 =item Returns: The Row object
438 Throws an exception if the row object is not yet in the database,
439 according to L</in_storage>.
441 This method issues an SQL UPDATE query to commit any changes to the
442 object to the database if required.
444 Also takes an optional hashref of C<< column_name => value> >> pairs
445 to update on the object first. Be aware that the hashref will be
446 passed to C<set_inflated_columns>, which might edit it in place, so
447 don't rely on it being the same after a call to C<update>. If you
448 need to preserve the hashref, it is sufficient to pass a shallow copy
449 to C<update>, e.g. ( { %{ $href } } )
451 If the values passed or any of the column values set on the object
452 contain scalar references, e.g.:
454 $row->last_modified(\'NOW()');
456 $row->update({ last_modified => \'NOW()' });
458 The update will pass the values verbatim into SQL. (See
459 L<SQL::Abstract> docs). The values in your Row object will NOT change
460 as a result of the update call, if you want the object to be updated
461 with the actual values from the database, call L</discard_changes>
464 $row->update()->discard_changes();
466 To determine before calling this method, which column values have
467 changed and will be updated, call L</get_dirty_columns>.
469 To check if any columns will be updated, call L</is_changed>.
471 To force a column to be updated, call L</make_column_dirty> before
477 my ($self, $upd) = @_;
478 $self->throw_exception( "Not in database" ) unless $self->in_storage;
480 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
482 $self->throw_exception('Unable to update a row with incomplete or no identity')
483 if ! keys %$ident_cond;
485 $self->set_inflated_columns($upd) if $upd;
486 my %to_update = $self->get_dirty_columns;
487 return $self unless keys %to_update;
488 my $rows = $self->result_source->storage->update(
489 $self->result_source, \%to_update, $ident_cond
492 $self->throw_exception( "Can't update ${self}: row not found" );
493 } elsif ($rows > 1) {
494 $self->throw_exception("Can't update ${self}: updated more than one row");
496 $self->{_dirty_columns} = {};
497 $self->{related_resultsets} = {};
498 delete $self->{_orig_ident};
508 =item Arguments: none
510 =item Returns: The Row object
514 Throws an exception if the object is not in the database according to
515 L</in_storage>. Runs an SQL DELETE statement using the primary key
516 values to locate the row.
518 The object is still perfectly usable, but L</in_storage> will
519 now return 0 and the object must be reinserted using L</insert>
520 before it can be used to L</update> the row again.
522 If you delete an object in a class with a C<has_many> relationship, an
523 attempt is made to delete all the related objects as well. To turn
524 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
525 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
526 database-level cascade or restrict will take precedence over a
527 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
528 main row first> and only then attempts to delete any remaining related
531 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
532 and the transaction subsequently fails, the row object will remain marked as
533 not being in storage. If you know for a fact that the object is still in
534 storage (i.e. by inspecting the cause of the transaction's failure), you can
535 use C<< $obj->in_storage(1) >> to restore consistency between the object and
536 the database. This would allow a subsequent C<< $obj->delete >> to work
539 See also L<DBIx::Class::ResultSet/delete>.
546 $self->throw_exception( "Not in database" ) unless $self->in_storage;
548 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
549 $self->throw_exception('Unable to delete a row with incomplete or no identity')
550 if ! keys %$ident_cond;
552 $self->result_source->storage->delete(
553 $self->result_source, $ident_cond
556 delete $self->{_orig_ident};
557 $self->in_storage(undef);
560 $self->throw_exception("Can't do class delete without a ResultSource instance")
561 unless $self->can('result_source_instance');
562 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
563 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
564 $self->result_source_instance->resultset->search(@_)->delete;
571 my $val = $row->get_column($col);
575 =item Arguments: $columnname
577 =item Returns: The value of the column
581 Throws an exception if the column name given doesn't exist according
584 Returns a raw column value from the row object, if it has already
585 been fetched from the database or set by an accessor.
587 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
588 will be deflated and returned.
590 Note that if you used the C<columns> or the C<select/as>
591 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
592 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
593 this method will return C<undef> even if the database contains some value.
595 To retrieve all loaded column values as a hash, use L</get_columns>.
600 my ($self, $column) = @_;
601 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
602 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
603 if (exists $self->{_inflated_column}{$column}) {
604 return $self->store_column($column,
605 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
607 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
611 =head2 has_column_loaded
613 if ( $row->has_column_loaded($col) ) {
614 print "$col has been loaded from db";
619 =item Arguments: $columnname
625 Returns a true value if the column value has been loaded from the
626 database (or set locally).
630 sub has_column_loaded {
631 my ($self, $column) = @_;
632 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
633 return 1 if exists $self->{_inflated_column}{$column};
634 return exists $self->{_column_data}{$column};
639 my %data = $row->get_columns;
643 =item Arguments: none
645 =item Returns: A hash of columnname, value pairs.
649 Returns all loaded column data as a hash, containing raw values. To
650 get just one value for a particular column, use L</get_column>.
652 See L</get_inflated_columns> to get the inflated values.
658 if (exists $self->{_inflated_column}) {
659 foreach my $col (keys %{$self->{_inflated_column}}) {
660 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
661 unless exists $self->{_column_data}{$col};
664 return %{$self->{_column_data}};
667 =head2 get_dirty_columns
669 my %data = $row->get_dirty_columns;
673 =item Arguments: none
675 =item Returns: A hash of column, value pairs
679 Only returns the column, value pairs for those columns that have been
680 changed on this object since the last L</update> or L</insert> call.
682 See L</get_columns> to fetch all column/value pairs.
686 sub get_dirty_columns {
688 return map { $_ => $self->{_column_data}{$_} }
689 keys %{$self->{_dirty_columns}};
692 =head2 make_column_dirty
694 $row->make_column_dirty($col)
698 =item Arguments: $columnname
700 =item Returns: undefined
704 Throws an exception if the column does not exist.
706 Marks a column as having been changed regardless of whether it has
710 sub make_column_dirty {
711 my ($self, $column) = @_;
713 $self->throw_exception( "No such column '${column}'" )
714 unless exists $self->{_column_data}{$column} || $self->has_column($column);
716 # the entire clean/dirty code relies on exists, not on true/false
717 return 1 if exists $self->{_dirty_columns}{$column};
719 $self->{_dirty_columns}{$column} = 1;
721 # if we are just now making the column dirty, and if there is an inflated
722 # value, force it over the deflated one
723 if (exists $self->{_inflated_column}{$column}) {
724 $self->store_column($column,
725 $self->_deflated_column(
726 $column, $self->{_inflated_column}{$column}
732 =head2 get_inflated_columns
734 my %inflated_data = $obj->get_inflated_columns;
738 =item Arguments: none
740 =item Returns: A hash of column, object|value pairs
744 Returns a hash of all column keys and associated values. Values for any
745 columns set to use inflation will be inflated and returns as objects.
747 See L</get_columns> to get the uninflated values.
749 See L<DBIx::Class::InflateColumn> for how to setup inflation.
753 sub get_inflated_columns {
756 my %loaded_colinfo = (map
757 { $_ => $self->column_info($_) }
758 (grep { $self->has_column_loaded($_) } $self->columns)
762 for my $col (keys %loaded_colinfo) {
763 if (exists $loaded_colinfo{$col}{accessor}) {
764 my $acc = $loaded_colinfo{$col}{accessor};
765 $inflated{$col} = $self->$acc if defined $acc;
768 $inflated{$col} = $self->$col;
772 # return all loaded columns with the inflations overlayed on top
773 return ($self->get_columns, %inflated);
776 sub _is_column_numeric {
777 my ($self, $column) = @_;
778 my $colinfo = $self->column_info ($column);
780 # cache for speed (the object may *not* have a resultsource instance)
781 if (not defined $colinfo->{is_numeric} && $self->_source_handle) {
782 $colinfo->{is_numeric} =
783 $self->result_source->schema->storage->is_datatype_numeric ($colinfo->{data_type})
789 return $colinfo->{is_numeric};
794 $row->set_column($col => $val);
798 =item Arguments: $columnname, $value
800 =item Returns: $value
804 Sets a raw column value. If the new value is different from the old one,
805 the column is marked as dirty for when you next call L</update>.
807 If passed an object or reference as a value, this method will happily
808 attempt to store it, and a later L</insert> or L</update> will try and
809 stringify/numify as appropriate. To set an object to be deflated
810 instead, see L</set_inflated_columns>.
815 my ($self, $column, $new_value) = @_;
817 # if we can't get an ident condition on first try - mark the object as unidentifiable
818 $self->{_orig_ident} ||= (eval { $self->ident_condition }) || {};
820 my $old_value = $self->get_column($column);
821 $new_value = $self->store_column($column, $new_value);
824 if (!$self->in_storage) { # no point tracking dirtyness on uninserted data
827 elsif (defined $old_value xor defined $new_value) {
830 elsif (not defined $old_value) { # both undef
833 elsif ($old_value eq $new_value) {
836 else { # do a numeric comparison if datatype allows it
837 if ($self->_is_column_numeric($column)) {
838 $dirty = $old_value != $new_value;
845 # sadly the update code just checks for keys, not for their value
846 $self->{_dirty_columns}{$column} = 1 if $dirty;
848 # XXX clear out the relation cache for this column
849 delete $self->{related_resultsets}{$column};
856 $row->set_columns({ $col => $val, ... });
860 =item Arguments: \%columndata
862 =item Returns: The Row object
866 Sets multiple column, raw value pairs at once.
868 Works as L</set_column>.
873 my ($self,$data) = @_;
874 foreach my $col (keys %$data) {
875 $self->set_column($col,$data->{$col});
880 =head2 set_inflated_columns
882 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
886 =item Arguments: \%columndata
888 =item Returns: The Row object
892 Sets more than one column value at once. Any inflated values are
893 deflated and the raw values stored.
895 Any related values passed as Row objects, using the relation name as a
896 key, are reduced to the appropriate foreign key values and stored. If
897 instead of related row objects, a hashref of column, value data is
898 passed, will create the related object first then store.
900 Will even accept arrayrefs of data as a value to a
901 L<DBIx::Class::Relationship/has_many> key, and create the related
902 objects if necessary.
904 Be aware that the input hashref might be edited in place, so don't rely
905 on it being the same after a call to C<set_inflated_columns>. If you
906 need to preserve the hashref, it is sufficient to pass a shallow copy
907 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
909 See also L<DBIx::Class::Relationship::Base/set_from_related>.
913 sub set_inflated_columns {
914 my ( $self, $upd ) = @_;
915 foreach my $key (keys %$upd) {
916 if (ref $upd->{$key}) {
917 my $info = $self->relationship_info($key);
918 my $acc_type = $info->{attrs}{accessor} || '';
919 if ($acc_type eq 'single') {
920 my $rel = delete $upd->{$key};
921 $self->set_from_related($key => $rel);
922 $self->{_relationship_data}{$key} = $rel;
924 elsif ($acc_type eq 'multi') {
925 $self->throw_exception(
926 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
929 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
930 $self->set_inflated_column($key, delete $upd->{$key});
934 $self->set_columns($upd);
939 my $copy = $orig->copy({ change => $to, ... });
943 =item Arguments: \%replacementdata
945 =item Returns: The Row object copy
949 Inserts a new row into the database, as a copy of the original
950 object. If a hashref of replacement data is supplied, these will take
951 precedence over data in the original. Also any columns which have
952 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
953 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
954 so that the database can insert its own autoincremented values into
957 Relationships will be followed by the copy procedure B<only> if the
958 relationship specifies a true value for its
959 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
960 is set by default on C<has_many> relationships and unset on all others.
965 my ($self, $changes) = @_;
967 my $col_data = { %{$self->{_column_data}} };
968 foreach my $col (keys %$col_data) {
969 delete $col_data->{$col}
970 if $self->result_source->column_info($col)->{is_auto_increment};
973 my $new = { _column_data => $col_data };
974 bless $new, ref $self;
976 $new->result_source($self->result_source);
977 $new->set_inflated_columns($changes);
980 # Its possible we'll have 2 relations to the same Source. We need to make
981 # sure we don't try to insert the same row twice else we'll violate unique
983 my $rels_copied = {};
985 foreach my $rel ($self->result_source->relationships) {
986 my $rel_info = $self->result_source->relationship_info($rel);
988 next unless $rel_info->{attrs}{cascade_copy};
990 my $resolved = $self->result_source->_resolve_condition(
991 $rel_info->{cond}, $rel, $new
994 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
995 foreach my $related ($self->search_related($rel)) {
996 my $id_str = join("\0", $related->id);
997 next if $copied->{$id_str};
998 $copied->{$id_str} = 1;
999 my $rel_copy = $related->copy($resolved);
1008 $row->store_column($col => $val);
1012 =item Arguments: $columnname, $value
1014 =item Returns: The value sent to storage
1018 Set a raw value for a column without marking it as changed. This
1019 method is used internally by L</set_column> which you should probably
1022 This is the lowest level at which data is set on a row object,
1023 extend this method to catch all data setting methods.
1028 my ($self, $column, $value) = @_;
1029 $self->throw_exception( "No such column '${column}'" )
1030 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1031 $self->throw_exception( "set_column called for ${column} without value" )
1033 return $self->{_column_data}{$column} = $value;
1036 =head2 inflate_result
1038 Class->inflate_result($result_source, \%me, \%prefetch?)
1042 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1044 =item Returns: A Row object
1048 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1049 database and turn it into row objects call this method.
1051 Extend this method in your Result classes to hook into this process,
1052 for example to rebless the result into a different class.
1054 Reblessing can also be done more easily by setting C<result_class> in
1055 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1057 Different types of results can also be created from a particular
1058 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1062 sub inflate_result {
1063 my ($class, $source, $me, $prefetch) = @_;
1065 my ($source_handle) = $source;
1067 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
1068 $source = $source_handle->resolve
1071 $source_handle = $source->handle
1075 _source_handle => $source_handle,
1076 _column_data => $me,
1078 bless $new, (ref $class || $class);
1080 foreach my $pre (keys %{$prefetch||{}}) {
1082 my $pre_source = $source->related_source($pre)
1083 or $class->throw_exception("Can't prefetch non-existent relationship ${pre}");
1085 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1086 or $class->throw_exception("No accessor for prefetched $pre");
1089 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1090 @pre_vals = @{$prefetch->{$pre}};
1092 elsif ($accessor eq 'multi') {
1093 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor 'multi'");
1096 @pre_vals = $prefetch->{$pre};
1100 for my $me_pref (@pre_vals) {
1102 # FIXME - this should not be necessary
1103 # the collapser currently *could* return bogus elements with all
1104 # columns set to undef
1106 for (values %{$me_pref->[0]}) {
1112 next unless $has_def;
1114 push @pre_objects, $pre_source->result_class->inflate_result(
1115 $pre_source, @$me_pref
1119 if ($accessor eq 'single') {
1120 $new->{_relationship_data}{$pre} = $pre_objects[0];
1122 elsif ($accessor eq 'filter') {
1123 $new->{_inflated_column}{$pre} = $pre_objects[0];
1126 $new->related_resultset($pre)->set_cache(\@pre_objects);
1129 $new->in_storage (1);
1133 =head2 update_or_insert
1135 $row->update_or_insert
1139 =item Arguments: none
1141 =item Returns: Result of update or insert operation
1145 L</Update>s the object if it's already in the database, according to
1146 L</in_storage>, else L</insert>s it.
1148 =head2 insert_or_update
1150 $obj->insert_or_update
1152 Alias for L</update_or_insert>
1156 sub insert_or_update { shift->update_or_insert(@_) }
1158 sub update_or_insert {
1160 return ($self->in_storage ? $self->update : $self->insert);
1165 my @changed_col_names = $row->is_changed();
1166 if ($row->is_changed()) { ... }
1170 =item Arguments: none
1172 =item Returns: 0|1 or @columnnames
1176 In list context returns a list of columns with uncommited changes, or
1177 in scalar context returns a true value if there are uncommitted
1183 return keys %{shift->{_dirty_columns} || {}};
1186 =head2 is_column_changed
1188 if ($row->is_column_changed('col')) { ... }
1192 =item Arguments: $columname
1198 Returns a true value if the column has uncommitted changes.
1202 sub is_column_changed {
1203 my( $self, $col ) = @_;
1204 return exists $self->{_dirty_columns}->{$col};
1207 =head2 result_source
1209 my $resultsource = $row->result_source;
1213 =item Arguments: none
1215 =item Returns: a ResultSource instance
1219 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1227 $self->_source_handle($_[0]->handle);
1229 $self->_source_handle->resolve;
1233 =head2 register_column
1235 $column_info = { .... };
1236 $class->register_column($column_name, $column_info);
1240 =item Arguments: $columnname, \%columninfo
1242 =item Returns: undefined
1246 Registers a column on the class. If the column_info has an 'accessor'
1247 key, creates an accessor named after the value if defined; if there is
1248 no such key, creates an accessor with the same name as the column
1250 The column_info attributes are described in
1251 L<DBIx::Class::ResultSource/add_columns>
1255 sub register_column {
1256 my ($class, $col, $info) = @_;
1258 if (exists $info->{accessor}) {
1259 return unless defined $info->{accessor};
1260 $acc = [ $info->{accessor}, $col ];
1262 $class->mk_group_accessors('column' => $acc);
1265 =head2 get_from_storage
1267 my $copy = $row->get_from_storage($attrs)
1271 =item Arguments: \%attrs
1273 =item Returns: A Row object
1277 Fetches a fresh copy of the Row object from the database and returns it.
1279 If passed the \%attrs argument, will first apply these attributes to
1280 the resultset used to find the row.
1282 This copy can then be used to compare to an existing row object, to
1283 determine if any changes have been made in the database since it was
1286 To just update your Row object with any latest changes from the
1287 database, use L</discard_changes> instead.
1289 The \%attrs argument should be compatible with
1290 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1294 sub get_from_storage {
1295 my $self = shift @_;
1296 my $attrs = shift @_;
1297 my $resultset = $self->result_source->resultset;
1299 if(defined $attrs) {
1300 $resultset = $resultset->search(undef, $attrs);
1303 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
1305 $self->throw_exception('Unable to requery a row with incomplete or no identity')
1306 if ! keys %$ident_cond;
1308 return $resultset->find($ident_cond);
1311 =head2 discard_changes ($attrs)
1313 Re-selects the row from the database, losing any changes that had
1316 This method can also be used to refresh from storage, retrieving any
1317 changes made since the row was last read from storage.
1319 $attrs is expected to be a hashref of attributes suitable for passing as the
1320 second argument to $resultset->search($cond, $attrs);
1324 sub discard_changes {
1325 my ($self, $attrs) = @_;
1326 delete $self->{_dirty_columns};
1327 return unless $self->in_storage; # Don't reload if we aren't real!
1329 # add a replication default to read from the master only
1330 $attrs = { force_pool => 'master', %{$attrs||{}} };
1332 if( my $current_storage = $self->get_from_storage($attrs)) {
1334 # Set $self to the current.
1335 %$self = %$current_storage;
1337 # Avoid a possible infinite loop with
1338 # sub DESTROY { $_[0]->discard_changes }
1339 bless $current_storage, 'Do::Not::Exist';
1344 $self->in_storage(0);
1350 =head2 throw_exception
1352 See L<DBIx::Class::Schema/throw_exception>.
1356 sub throw_exception {
1359 if (ref $self && ref $self->result_source && $self->result_source->schema) {
1360 $self->result_source->schema->throw_exception(@_)
1363 DBIx::Class::Exception->throw(@_);
1373 =item Arguments: none
1375 =item Returns: A list of primary key values
1379 Returns the primary key(s) for a row. Can't be called as a class method.
1380 Actually implemented in L<DBIx::Class::PK>
1382 =head2 discard_changes
1384 $row->discard_changes
1388 =item Arguments: none
1390 =item Returns: nothing (updates object in-place)
1394 Retrieves and sets the row object data from the database, losing any
1397 This method can also be used to refresh from storage, retrieving any
1398 changes made since the row was last read from storage. Actually
1399 implemented in L<DBIx::Class::PK>
1401 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1402 storage, please kept in mind that if you L</discard_changes> on a row that you
1403 just updated or created, you should wrap the entire bit inside a transaction.
1404 Otherwise you run the risk that you insert or update to the master database
1405 but read from a replicant database that has not yet been updated from the
1406 master. This will result in unexpected results.
1414 Matt S. Trout <mst@shadowcatsystems.co.uk>
1418 You may distribute this code under the same terms as Perl itself.