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 (see L</get_dirty_columns>).
443 It throws an exception if a proper WHERE clause uniquely identifying
444 the database row can not be constructed (see
445 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
448 Also takes an optional hashref of C<< column_name => value> >> pairs
449 to update on the object first. Be aware that the hashref will be
450 passed to C<set_inflated_columns>, which might edit it in place, so
451 don't rely on it being the same after a call to C<update>. If you
452 need to preserve the hashref, it is sufficient to pass a shallow copy
453 to C<update>, e.g. ( { %{ $href } } )
455 If the values passed or any of the column values set on the object
456 contain scalar references, e.g.:
458 $row->last_modified(\'NOW()');
460 $row->update({ last_modified => \'NOW()' });
462 The update will pass the values verbatim into SQL. (See
463 L<SQL::Abstract> docs). The values in your Row object will NOT change
464 as a result of the update call, if you want the object to be updated
465 with the actual values from the database, call L</discard_changes>
468 $row->update()->discard_changes();
470 To determine before calling this method, which column values have
471 changed and will be updated, call L</get_dirty_columns>.
473 To check if any columns will be updated, call L</is_changed>.
475 To force a column to be updated, call L</make_column_dirty> before
481 my ($self, $upd) = @_;
482 $self->throw_exception( "Not in database" ) unless $self->in_storage;
484 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
486 $self->throw_exception('Unable to update a row with incomplete or no identity')
487 if ! keys %$ident_cond;
489 $self->set_inflated_columns($upd) if $upd;
490 my %to_update = $self->get_dirty_columns;
491 return $self unless keys %to_update;
492 my $rows = $self->result_source->storage->update(
493 $self->result_source, \%to_update, $ident_cond
496 $self->throw_exception( "Can't update ${self}: row not found" );
497 } elsif ($rows > 1) {
498 $self->throw_exception("Can't update ${self}: updated more than one row");
500 $self->{_dirty_columns} = {};
501 $self->{related_resultsets} = {};
502 delete $self->{_orig_ident};
512 =item Arguments: none
514 =item Returns: The Row object
518 Throws an exception if the object is not in the database according to
519 L</in_storage>. Also throws an exception if a proper WHERE clause
520 uniquely identifying the database row can not be constructed (see
521 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
524 The object is still perfectly usable, but L</in_storage> will
525 now return 0 and the object must be reinserted using L</insert>
526 before it can be used to L</update> the row again.
528 If you delete an object in a class with a C<has_many> relationship, an
529 attempt is made to delete all the related objects as well. To turn
530 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
531 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
532 database-level cascade or restrict will take precedence over a
533 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
534 main row first> and only then attempts to delete any remaining related
537 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
538 and the transaction subsequently fails, the row object will remain marked as
539 not being in storage. If you know for a fact that the object is still in
540 storage (i.e. by inspecting the cause of the transaction's failure), you can
541 use C<< $obj->in_storage(1) >> to restore consistency between the object and
542 the database. This would allow a subsequent C<< $obj->delete >> to work
545 See also L<DBIx::Class::ResultSet/delete>.
552 $self->throw_exception( "Not in database" ) unless $self->in_storage;
554 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
555 $self->throw_exception('Unable to delete a row with incomplete or no identity')
556 if ! keys %$ident_cond;
558 $self->result_source->storage->delete(
559 $self->result_source, $ident_cond
562 delete $self->{_orig_ident};
563 $self->in_storage(undef);
566 $self->throw_exception("Can't do class delete without a ResultSource instance")
567 unless $self->can('result_source_instance');
568 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
569 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
570 $self->result_source_instance->resultset->search(@_)->delete;
577 my $val = $row->get_column($col);
581 =item Arguments: $columnname
583 =item Returns: The value of the column
587 Throws an exception if the column name given doesn't exist according
590 Returns a raw column value from the row object, if it has already
591 been fetched from the database or set by an accessor.
593 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
594 will be deflated and returned.
596 Note that if you used the C<columns> or the C<select/as>
597 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
598 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
599 this method will return C<undef> even if the database contains some value.
601 To retrieve all loaded column values as a hash, use L</get_columns>.
606 my ($self, $column) = @_;
607 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
608 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
609 if (exists $self->{_inflated_column}{$column}) {
610 return $self->store_column($column,
611 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
613 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
617 =head2 has_column_loaded
619 if ( $row->has_column_loaded($col) ) {
620 print "$col has been loaded from db";
625 =item Arguments: $columnname
631 Returns a true value if the column value has been loaded from the
632 database (or set locally).
636 sub has_column_loaded {
637 my ($self, $column) = @_;
638 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
639 return 1 if exists $self->{_inflated_column}{$column};
640 return exists $self->{_column_data}{$column};
645 my %data = $row->get_columns;
649 =item Arguments: none
651 =item Returns: A hash of columnname, value pairs.
655 Returns all loaded column data as a hash, containing raw values. To
656 get just one value for a particular column, use L</get_column>.
658 See L</get_inflated_columns> to get the inflated values.
664 if (exists $self->{_inflated_column}) {
665 foreach my $col (keys %{$self->{_inflated_column}}) {
666 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
667 unless exists $self->{_column_data}{$col};
670 return %{$self->{_column_data}};
673 =head2 get_dirty_columns
675 my %data = $row->get_dirty_columns;
679 =item Arguments: none
681 =item Returns: A hash of column, value pairs
685 Only returns the column, value pairs for those columns that have been
686 changed on this object since the last L</update> or L</insert> call.
688 See L</get_columns> to fetch all column/value pairs.
692 sub get_dirty_columns {
694 return map { $_ => $self->{_column_data}{$_} }
695 keys %{$self->{_dirty_columns}};
698 =head2 make_column_dirty
700 $row->make_column_dirty($col)
704 =item Arguments: $columnname
706 =item Returns: undefined
710 Throws an exception if the column does not exist.
712 Marks a column as having been changed regardless of whether it has
716 sub make_column_dirty {
717 my ($self, $column) = @_;
719 $self->throw_exception( "No such column '${column}'" )
720 unless exists $self->{_column_data}{$column} || $self->has_column($column);
722 # the entire clean/dirty code relies on exists, not on true/false
723 return 1 if exists $self->{_dirty_columns}{$column};
725 $self->{_dirty_columns}{$column} = 1;
727 # if we are just now making the column dirty, and if there is an inflated
728 # value, force it over the deflated one
729 if (exists $self->{_inflated_column}{$column}) {
730 $self->store_column($column,
731 $self->_deflated_column(
732 $column, $self->{_inflated_column}{$column}
738 =head2 get_inflated_columns
740 my %inflated_data = $obj->get_inflated_columns;
744 =item Arguments: none
746 =item Returns: A hash of column, object|value pairs
750 Returns a hash of all column keys and associated values. Values for any
751 columns set to use inflation will be inflated and returns as objects.
753 See L</get_columns> to get the uninflated values.
755 See L<DBIx::Class::InflateColumn> for how to setup inflation.
759 sub get_inflated_columns {
762 my %loaded_colinfo = (map
763 { $_ => $self->column_info($_) }
764 (grep { $self->has_column_loaded($_) } $self->columns)
768 for my $col (keys %loaded_colinfo) {
769 if (exists $loaded_colinfo{$col}{accessor}) {
770 my $acc = $loaded_colinfo{$col}{accessor};
771 $inflated{$col} = $self->$acc if defined $acc;
774 $inflated{$col} = $self->$col;
778 # return all loaded columns with the inflations overlayed on top
779 return ($self->get_columns, %inflated);
782 sub _is_column_numeric {
783 my ($self, $column) = @_;
784 my $colinfo = $self->column_info ($column);
786 # cache for speed (the object may *not* have a resultsource instance)
787 if (not defined $colinfo->{is_numeric} && $self->_source_handle) {
788 $colinfo->{is_numeric} =
789 $self->result_source->schema->storage->is_datatype_numeric ($colinfo->{data_type})
795 return $colinfo->{is_numeric};
800 $row->set_column($col => $val);
804 =item Arguments: $columnname, $value
806 =item Returns: $value
810 Sets a raw column value. If the new value is different from the old one,
811 the column is marked as dirty for when you next call L</update>.
813 If passed an object or reference as a value, this method will happily
814 attempt to store it, and a later L</insert> or L</update> will try and
815 stringify/numify as appropriate. To set an object to be deflated
816 instead, see L</set_inflated_columns>.
821 my ($self, $column, $new_value) = @_;
823 # if we can't get an ident condition on first try - mark the object as unidentifiable
824 $self->{_orig_ident} ||= (eval { $self->ident_condition }) || {};
826 my $old_value = $self->get_column($column);
827 $new_value = $self->store_column($column, $new_value);
830 if (!$self->in_storage) { # no point tracking dirtyness on uninserted data
833 elsif (defined $old_value xor defined $new_value) {
836 elsif (not defined $old_value) { # both undef
839 elsif ($old_value eq $new_value) {
842 else { # do a numeric comparison if datatype allows it
843 if ($self->_is_column_numeric($column)) {
844 $dirty = $old_value != $new_value;
851 # sadly the update code just checks for keys, not for their value
852 $self->{_dirty_columns}{$column} = 1 if $dirty;
854 # XXX clear out the relation cache for this column
855 delete $self->{related_resultsets}{$column};
862 $row->set_columns({ $col => $val, ... });
866 =item Arguments: \%columndata
868 =item Returns: The Row object
872 Sets multiple column, raw value pairs at once.
874 Works as L</set_column>.
879 my ($self,$data) = @_;
880 foreach my $col (keys %$data) {
881 $self->set_column($col,$data->{$col});
886 =head2 set_inflated_columns
888 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
892 =item Arguments: \%columndata
894 =item Returns: The Row object
898 Sets more than one column value at once. Any inflated values are
899 deflated and the raw values stored.
901 Any related values passed as Row objects, using the relation name as a
902 key, are reduced to the appropriate foreign key values and stored. If
903 instead of related row objects, a hashref of column, value data is
904 passed, will create the related object first then store.
906 Will even accept arrayrefs of data as a value to a
907 L<DBIx::Class::Relationship/has_many> key, and create the related
908 objects if necessary.
910 Be aware that the input hashref might be edited in place, so don't rely
911 on it being the same after a call to C<set_inflated_columns>. If you
912 need to preserve the hashref, it is sufficient to pass a shallow copy
913 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
915 See also L<DBIx::Class::Relationship::Base/set_from_related>.
919 sub set_inflated_columns {
920 my ( $self, $upd ) = @_;
921 foreach my $key (keys %$upd) {
922 if (ref $upd->{$key}) {
923 my $info = $self->relationship_info($key);
924 my $acc_type = $info->{attrs}{accessor} || '';
925 if ($acc_type eq 'single') {
926 my $rel = delete $upd->{$key};
927 $self->set_from_related($key => $rel);
928 $self->{_relationship_data}{$key} = $rel;
930 elsif ($acc_type eq 'multi') {
931 $self->throw_exception(
932 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
935 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
936 $self->set_inflated_column($key, delete $upd->{$key});
940 $self->set_columns($upd);
945 my $copy = $orig->copy({ change => $to, ... });
949 =item Arguments: \%replacementdata
951 =item Returns: The Row object copy
955 Inserts a new row into the database, as a copy of the original
956 object. If a hashref of replacement data is supplied, these will take
957 precedence over data in the original. Also any columns which have
958 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
959 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
960 so that the database can insert its own autoincremented values into
963 Relationships will be followed by the copy procedure B<only> if the
964 relationship specifies a true value for its
965 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
966 is set by default on C<has_many> relationships and unset on all others.
971 my ($self, $changes) = @_;
973 my $col_data = { %{$self->{_column_data}} };
974 foreach my $col (keys %$col_data) {
975 delete $col_data->{$col}
976 if $self->result_source->column_info($col)->{is_auto_increment};
979 my $new = { _column_data => $col_data };
980 bless $new, ref $self;
982 $new->result_source($self->result_source);
983 $new->set_inflated_columns($changes);
986 # Its possible we'll have 2 relations to the same Source. We need to make
987 # sure we don't try to insert the same row twice else we'll violate unique
989 my $rels_copied = {};
991 foreach my $rel ($self->result_source->relationships) {
992 my $rel_info = $self->result_source->relationship_info($rel);
994 next unless $rel_info->{attrs}{cascade_copy};
996 my $resolved = $self->result_source->_resolve_condition(
997 $rel_info->{cond}, $rel, $new
1000 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1001 foreach my $related ($self->search_related($rel)) {
1002 my $id_str = join("\0", $related->id);
1003 next if $copied->{$id_str};
1004 $copied->{$id_str} = 1;
1005 my $rel_copy = $related->copy($resolved);
1014 $row->store_column($col => $val);
1018 =item Arguments: $columnname, $value
1020 =item Returns: The value sent to storage
1024 Set a raw value for a column without marking it as changed. This
1025 method is used internally by L</set_column> which you should probably
1028 This is the lowest level at which data is set on a row object,
1029 extend this method to catch all data setting methods.
1034 my ($self, $column, $value) = @_;
1035 $self->throw_exception( "No such column '${column}'" )
1036 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1037 $self->throw_exception( "set_column called for ${column} without value" )
1039 return $self->{_column_data}{$column} = $value;
1042 =head2 inflate_result
1044 Class->inflate_result($result_source, \%me, \%prefetch?)
1048 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1050 =item Returns: A Row object
1054 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1055 database and turn it into row objects call this method.
1057 Extend this method in your Result classes to hook into this process,
1058 for example to rebless the result into a different class.
1060 Reblessing can also be done more easily by setting C<result_class> in
1061 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1063 Different types of results can also be created from a particular
1064 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1068 sub inflate_result {
1069 my ($class, $source, $me, $prefetch) = @_;
1071 my ($source_handle) = $source;
1073 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
1074 $source = $source_handle->resolve
1077 $source_handle = $source->handle
1081 _source_handle => $source_handle,
1082 _column_data => $me,
1084 bless $new, (ref $class || $class);
1086 foreach my $pre (keys %{$prefetch||{}}) {
1088 my $pre_source = $source->related_source($pre)
1089 or $class->throw_exception("Can't prefetch non-existent relationship ${pre}");
1091 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1092 or $class->throw_exception("No accessor for prefetched $pre");
1095 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1096 @pre_vals = @{$prefetch->{$pre}};
1098 elsif ($accessor eq 'multi') {
1099 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor 'multi'");
1102 @pre_vals = $prefetch->{$pre};
1106 for my $me_pref (@pre_vals) {
1108 # FIXME - this should not be necessary
1109 # the collapser currently *could* return bogus elements with all
1110 # columns set to undef
1112 for (values %{$me_pref->[0]}) {
1118 next unless $has_def;
1120 push @pre_objects, $pre_source->result_class->inflate_result(
1121 $pre_source, @$me_pref
1125 if ($accessor eq 'single') {
1126 $new->{_relationship_data}{$pre} = $pre_objects[0];
1128 elsif ($accessor eq 'filter') {
1129 $new->{_inflated_column}{$pre} = $pre_objects[0];
1132 $new->related_resultset($pre)->set_cache(\@pre_objects);
1135 $new->in_storage (1);
1139 =head2 update_or_insert
1141 $row->update_or_insert
1145 =item Arguments: none
1147 =item Returns: Result of update or insert operation
1151 L</Update>s the object if it's already in the database, according to
1152 L</in_storage>, else L</insert>s it.
1154 =head2 insert_or_update
1156 $obj->insert_or_update
1158 Alias for L</update_or_insert>
1162 sub insert_or_update { shift->update_or_insert(@_) }
1164 sub update_or_insert {
1166 return ($self->in_storage ? $self->update : $self->insert);
1171 my @changed_col_names = $row->is_changed();
1172 if ($row->is_changed()) { ... }
1176 =item Arguments: none
1178 =item Returns: 0|1 or @columnnames
1182 In list context returns a list of columns with uncommited changes, or
1183 in scalar context returns a true value if there are uncommitted
1189 return keys %{shift->{_dirty_columns} || {}};
1192 =head2 is_column_changed
1194 if ($row->is_column_changed('col')) { ... }
1198 =item Arguments: $columname
1204 Returns a true value if the column has uncommitted changes.
1208 sub is_column_changed {
1209 my( $self, $col ) = @_;
1210 return exists $self->{_dirty_columns}->{$col};
1213 =head2 result_source
1215 my $resultsource = $row->result_source;
1219 =item Arguments: none
1221 =item Returns: a ResultSource instance
1225 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1233 $self->_source_handle($_[0]->handle);
1235 $self->_source_handle->resolve;
1239 =head2 register_column
1241 $column_info = { .... };
1242 $class->register_column($column_name, $column_info);
1246 =item Arguments: $columnname, \%columninfo
1248 =item Returns: undefined
1252 Registers a column on the class. If the column_info has an 'accessor'
1253 key, creates an accessor named after the value if defined; if there is
1254 no such key, creates an accessor with the same name as the column
1256 The column_info attributes are described in
1257 L<DBIx::Class::ResultSource/add_columns>
1261 sub register_column {
1262 my ($class, $col, $info) = @_;
1264 if (exists $info->{accessor}) {
1265 return unless defined $info->{accessor};
1266 $acc = [ $info->{accessor}, $col ];
1268 $class->mk_group_accessors('column' => $acc);
1271 =head2 get_from_storage
1273 my $copy = $row->get_from_storage($attrs)
1277 =item Arguments: \%attrs
1279 =item Returns: A Row object
1283 Fetches a fresh copy of the Row object from the database and returns it.
1284 Throws an exception if a proper WHERE clause identifying the database row
1285 can not be constructed (i.e. if the original object does not contain its
1287 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1288 ). If passed the \%attrs argument, will first apply these attributes to
1289 the resultset used to find the row.
1291 This copy can then be used to compare to an existing row object, to
1292 determine if any changes have been made in the database since it was
1295 To just update your Row object with any latest changes from the
1296 database, use L</discard_changes> instead.
1298 The \%attrs argument should be compatible with
1299 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1303 sub get_from_storage {
1304 my $self = shift @_;
1305 my $attrs = shift @_;
1306 my $resultset = $self->result_source->resultset;
1308 if(defined $attrs) {
1309 $resultset = $resultset->search(undef, $attrs);
1312 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
1314 $self->throw_exception('Unable to requery a row with incomplete or no identity')
1315 if ! keys %$ident_cond;
1317 return $resultset->find($ident_cond);
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.