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;
353 # get non-PK auto-incs
356 @pk{ $self->primary_columns } = ();
358 my @non_pk_autoincs = grep {
360 && $self->column_info($_)->{is_auto_increment}
363 if (@non_pk_autoincs) {
364 my @ids = $self->result_source->storage->last_insert_id(
365 $self->result_source,
369 if (@ids == @non_pk_autoincs) {
370 $self->store_column($non_pk_autoincs[$_] => $ids[$_]) for 0 .. $#ids;
375 $self->{_dirty_columns} = {};
376 $self->{related_resultsets} = {};
378 foreach my $relname (keys %related_stuff) {
379 next unless $source->has_relationship ($relname);
381 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
382 ? @{$related_stuff{$relname}}
383 : $related_stuff{$relname}
387 && Scalar::Util::blessed($cands[0])
388 && $cands[0]->isa('DBIx::Class::Row')
390 my $reverse = $source->reverse_relationship_info($relname);
391 foreach my $obj (@cands) {
392 $obj->set_from_related($_, $self) for keys %$reverse;
393 my $them = { %{$obj->{_relationship_data} || {} }, $obj->get_inflated_columns };
394 if ($self->__their_pk_needs_us($relname, $them)) {
395 if (exists $self->{_ignore_at_insert}{$relname}) {
396 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
398 MULTICREATE_DEBUG and warn "MC $self re-creating $relname $obj";
399 my $re = $self->result_source
400 ->related_source($relname)
404 MULTICREATE_DEBUG and warn "MC $self new $relname $obj";
407 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
414 $self->in_storage(1);
415 delete $self->{_orig_ident};
416 delete $self->{_ignore_at_insert};
417 $rollback_guard->commit if $rollback_guard;
424 $row->in_storage; # Get value
425 $row->in_storage(1); # Set value
429 =item Arguments: none or 1|0
435 Indicates whether the object exists as a row in the database or
436 not. This is set to true when L<DBIx::Class::ResultSet/find>,
437 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
440 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
441 L</delete> on one, sets it to false.
446 my ($self, $val) = @_;
447 $self->{_in_storage} = $val if @_ > 1;
448 return $self->{_in_storage} ? 1 : 0;
453 $row->update(\%columns?)
457 =item Arguments: none or a hashref
459 =item Returns: The Row object
463 Throws an exception if the row object is not yet in the database,
464 according to L</in_storage>.
466 This method issues an SQL UPDATE query to commit any changes to the
467 object to the database if required.
469 Also takes an optional hashref of C<< column_name => value> >> pairs
470 to update on the object first. Be aware that the hashref will be
471 passed to C<set_inflated_columns>, which might edit it in place, so
472 don't rely on it being the same after a call to C<update>. If you
473 need to preserve the hashref, it is sufficient to pass a shallow copy
474 to C<update>, e.g. ( { %{ $href } } )
476 If the values passed or any of the column values set on the object
477 contain scalar references, eg:
479 $row->last_modified(\'NOW()');
481 $row->update({ last_modified => \'NOW()' });
483 The update will pass the values verbatim into SQL. (See
484 L<SQL::Abstract> docs). The values in your Row object will NOT change
485 as a result of the update call, if you want the object to be updated
486 with the actual values from the database, call L</discard_changes>
489 $row->update()->discard_changes();
491 To determine before calling this method, which column values have
492 changed and will be updated, call L</get_dirty_columns>.
494 To check if any columns will be updated, call L</is_changed>.
496 To force a column to be updated, call L</make_column_dirty> before
502 my ($self, $upd) = @_;
503 $self->throw_exception( "Not in database" ) unless $self->in_storage;
504 my $ident_cond = $self->ident_condition;
505 $self->throw_exception("Cannot safely update a row in a PK-less table")
506 if ! keys %$ident_cond;
508 $self->set_inflated_columns($upd) if $upd;
509 my %to_update = $self->get_dirty_columns;
510 return $self unless keys %to_update;
511 my $rows = $self->result_source->storage->update(
512 $self->result_source, \%to_update,
513 $self->{_orig_ident} || $ident_cond
516 $self->throw_exception( "Can't update ${self}: row not found" );
517 } elsif ($rows > 1) {
518 $self->throw_exception("Can't update ${self}: updated more than one row");
520 $self->{_dirty_columns} = {};
521 $self->{related_resultsets} = {};
522 undef $self->{_orig_ident};
532 =item Arguments: none
534 =item Returns: The Row object
538 Throws an exception if the object is not in the database according to
539 L</in_storage>. Runs an SQL DELETE statement using the primary key
540 values to locate the row.
542 The object is still perfectly usable, but L</in_storage> will
543 now return 0 and the object must be reinserted using L</insert>
544 before it can be used to L</update> the row again.
546 If you delete an object in a class with a C<has_many> relationship, an
547 attempt is made to delete all the related objects as well. To turn
548 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
549 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
550 database-level cascade or restrict will take precedence over a
551 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
552 main row first> and only then attempts to delete any remaining related
555 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
556 and the transaction subsequently fails, the row object will remain marked as
557 not being in storage. If you know for a fact that the object is still in
558 storage (i.e. by inspecting the cause of the transaction's failure), you can
559 use C<< $obj->in_storage(1) >> to restore consistency between the object and
560 the database. This would allow a subsequent C<< $obj->delete >> to work
563 See also L<DBIx::Class::ResultSet/delete>.
570 $self->throw_exception( "Not in database" ) unless $self->in_storage;
571 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
572 $self->throw_exception("Cannot safely delete a row in a PK-less table")
573 if ! keys %$ident_cond;
574 foreach my $column (keys %$ident_cond) {
575 $self->throw_exception("Can't delete the object unless it has loaded the primary keys")
576 unless exists $self->{_column_data}{$column};
578 $self->result_source->storage->delete(
579 $self->result_source, $ident_cond);
580 $self->in_storage(undef);
582 $self->throw_exception("Can't do class delete without a ResultSource instance")
583 unless $self->can('result_source_instance');
584 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
585 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
586 $self->result_source_instance->resultset->search(@_)->delete;
593 my $val = $row->get_column($col);
597 =item Arguments: $columnname
599 =item Returns: The value of the column
603 Throws an exception if the column name given doesn't exist according
606 Returns a raw column value from the row object, if it has already
607 been fetched from the database or set by an accessor.
609 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
610 will be deflated and returned.
612 Note that if you used the C<columns> or the C<select/as>
613 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
614 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
615 this method will return C<undef> even if the database contains some value.
617 To retrieve all loaded column values as a hash, use L</get_columns>.
622 my ($self, $column) = @_;
623 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
624 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
625 if (exists $self->{_inflated_column}{$column}) {
626 return $self->store_column($column,
627 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
629 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
633 =head2 has_column_loaded
635 if ( $row->has_column_loaded($col) ) {
636 print "$col has been loaded from db";
641 =item Arguments: $columnname
647 Returns a true value if the column value has been loaded from the
648 database (or set locally).
652 sub has_column_loaded {
653 my ($self, $column) = @_;
654 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
655 return 1 if exists $self->{_inflated_column}{$column};
656 return exists $self->{_column_data}{$column};
661 my %data = $row->get_columns;
665 =item Arguments: none
667 =item Returns: A hash of columnname, value pairs.
671 Returns all loaded column data as a hash, containing raw values. To
672 get just one value for a particular column, use L</get_column>.
674 See L</get_inflated_columns> to get the inflated values.
680 if (exists $self->{_inflated_column}) {
681 foreach my $col (keys %{$self->{_inflated_column}}) {
682 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
683 unless exists $self->{_column_data}{$col};
686 return %{$self->{_column_data}};
689 =head2 get_dirty_columns
691 my %data = $row->get_dirty_columns;
695 =item Arguments: none
697 =item Returns: A hash of column, value pairs
701 Only returns the column, value pairs for those columns that have been
702 changed on this object since the last L</update> or L</insert> call.
704 See L</get_columns> to fetch all column/value pairs.
708 sub get_dirty_columns {
710 return map { $_ => $self->{_column_data}{$_} }
711 keys %{$self->{_dirty_columns}};
714 =head2 make_column_dirty
716 $row->make_column_dirty($col)
720 =item Arguments: $columnname
722 =item Returns: undefined
726 Throws an exception if the column does not exist.
728 Marks a column as having been changed regardless of whether it has
732 sub make_column_dirty {
733 my ($self, $column) = @_;
735 $self->throw_exception( "No such column '${column}'" )
736 unless exists $self->{_column_data}{$column} || $self->has_column($column);
738 # the entire clean/dirty code relies on exists, not on true/false
739 return 1 if exists $self->{_dirty_columns}{$column};
741 $self->{_dirty_columns}{$column} = 1;
743 # if we are just now making the column dirty, and if there is an inflated
744 # value, force it over the deflated one
745 if (exists $self->{_inflated_column}{$column}) {
746 $self->store_column($column,
747 $self->_deflated_column(
748 $column, $self->{_inflated_column}{$column}
754 =head2 get_inflated_columns
756 my %inflated_data = $obj->get_inflated_columns;
760 =item Arguments: none
762 =item Returns: A hash of column, object|value pairs
766 Returns a hash of all column keys and associated values. Values for any
767 columns set to use inflation will be inflated and returns as objects.
769 See L</get_columns> to get the uninflated values.
771 See L<DBIx::Class::InflateColumn> for how to setup inflation.
775 sub get_inflated_columns {
778 my %loaded_colinfo = (map
779 { $_ => $self->column_info($_) }
780 (grep { $self->has_column_loaded($_) } $self->columns)
784 for my $col (keys %loaded_colinfo) {
785 if (exists $loaded_colinfo{$col}{accessor}) {
786 my $acc = $loaded_colinfo{$col}{accessor};
788 $inflated{$col} = $self->$acc;
792 $inflated{$col} = $self->$col;
796 # return all loaded columns with the inflations overlayed on top
797 return ($self->get_columns, %inflated);
800 sub _is_column_numeric {
801 my ($self, $column) = @_;
802 my $colinfo = $self->column_info ($column);
804 # cache for speed (the object may *not* have a resultsource instance)
805 if (not defined $colinfo->{is_numeric} && $self->_source_handle) {
806 $colinfo->{is_numeric} =
807 $self->result_source->schema->storage->is_datatype_numeric ($colinfo->{data_type})
813 return $colinfo->{is_numeric};
818 $row->set_column($col => $val);
822 =item Arguments: $columnname, $value
824 =item Returns: $value
828 Sets a raw column value. If the new value is different from the old one,
829 the column is marked as dirty for when you next call L</update>.
831 If passed an object or reference as a value, this method will happily
832 attempt to store it, and a later L</insert> or L</update> will try and
833 stringify/numify as appropriate. To set an object to be deflated
834 instead, see L</set_inflated_columns>.
839 my ($self, $column, $new_value) = @_;
841 $self->{_orig_ident} ||= $self->ident_condition;
842 my $old_value = $self->get_column($column);
844 $new_value = $self->store_column($column, $new_value);
847 if (!$self->in_storage) { # no point tracking dirtyness on uninserted data
850 elsif (defined $old_value xor defined $new_value) {
853 elsif (not defined $old_value) { # both undef
856 elsif ($old_value eq $new_value) {
859 else { # do a numeric comparison if datatype allows it
860 if ($self->_is_column_numeric($column)) {
861 $dirty = $old_value != $new_value;
868 # sadly the update code just checks for keys, not for their value
869 $self->{_dirty_columns}{$column} = 1 if $dirty;
871 # XXX clear out the relation cache for this column
872 delete $self->{related_resultsets}{$column};
879 $row->set_columns({ $col => $val, ... });
883 =item Arguments: \%columndata
885 =item Returns: The Row object
889 Sets multiple column, raw value pairs at once.
891 Works as L</set_column>.
896 my ($self,$data) = @_;
897 foreach my $col (keys %$data) {
898 $self->set_column($col,$data->{$col});
903 =head2 set_inflated_columns
905 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
909 =item Arguments: \%columndata
911 =item Returns: The Row object
915 Sets more than one column value at once. Any inflated values are
916 deflated and the raw values stored.
918 Any related values passed as Row objects, using the relation name as a
919 key, are reduced to the appropriate foreign key values and stored. If
920 instead of related row objects, a hashref of column, value data is
921 passed, will create the related object first then store.
923 Will even accept arrayrefs of data as a value to a
924 L<DBIx::Class::Relationship/has_many> key, and create the related
925 objects if necessary.
927 Be aware that the input hashref might be edited in place, so dont rely
928 on it being the same after a call to C<set_inflated_columns>. If you
929 need to preserve the hashref, it is sufficient to pass a shallow copy
930 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
932 See also L<DBIx::Class::Relationship::Base/set_from_related>.
936 sub set_inflated_columns {
937 my ( $self, $upd ) = @_;
938 foreach my $key (keys %$upd) {
939 if (ref $upd->{$key}) {
940 my $info = $self->relationship_info($key);
941 if ($info && $info->{attrs}{accessor}
942 && $info->{attrs}{accessor} eq 'single')
944 my $rel = delete $upd->{$key};
945 $self->set_from_related($key => $rel);
946 $self->{_relationship_data}{$key} = $rel;
947 } elsif ($info && $info->{attrs}{accessor}
948 && $info->{attrs}{accessor} eq 'multi') {
949 $self->throw_exception(
950 "Recursive update is not supported over relationships of type multi ($key)"
953 elsif ($self->has_column($key)
954 && exists $self->column_info($key)->{_inflate_info})
956 $self->set_inflated_column($key, delete $upd->{$key});
960 $self->set_columns($upd);
965 my $copy = $orig->copy({ change => $to, ... });
969 =item Arguments: \%replacementdata
971 =item Returns: The Row object copy
975 Inserts a new row into the database, as a copy of the original
976 object. If a hashref of replacement data is supplied, these will take
977 precedence over data in the original. Also any columns which have
978 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
979 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
980 so that the database can insert its own autoincremented values into
983 Relationships will be followed by the copy procedure B<only> if the
984 relationship specifes a true value for its
985 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
986 is set by default on C<has_many> relationships and unset on all others.
991 my ($self, $changes) = @_;
993 my $col_data = { %{$self->{_column_data}} };
994 foreach my $col (keys %$col_data) {
995 delete $col_data->{$col}
996 if $self->result_source->column_info($col)->{is_auto_increment};
999 my $new = { _column_data => $col_data };
1000 bless $new, ref $self;
1002 $new->result_source($self->result_source);
1003 $new->set_inflated_columns($changes);
1006 # Its possible we'll have 2 relations to the same Source. We need to make
1007 # sure we don't try to insert the same row twice esle we'll violate unique
1009 my $rels_copied = {};
1011 foreach my $rel ($self->result_source->relationships) {
1012 my $rel_info = $self->result_source->relationship_info($rel);
1014 next unless $rel_info->{attrs}{cascade_copy};
1016 my $resolved = $self->result_source->_resolve_condition(
1017 $rel_info->{cond}, $rel, $new
1020 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1021 foreach my $related ($self->search_related($rel)) {
1022 my $id_str = join("\0", $related->id);
1023 next if $copied->{$id_str};
1024 $copied->{$id_str} = 1;
1025 my $rel_copy = $related->copy($resolved);
1034 $row->store_column($col => $val);
1038 =item Arguments: $columnname, $value
1040 =item Returns: The value sent to storage
1044 Set a raw value for a column without marking it as changed. This
1045 method is used internally by L</set_column> which you should probably
1048 This is the lowest level at which data is set on a row object,
1049 extend this method to catch all data setting methods.
1054 my ($self, $column, $value) = @_;
1055 $self->throw_exception( "No such column '${column}'" )
1056 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1057 $self->throw_exception( "set_column called for ${column} without value" )
1059 return $self->{_column_data}{$column} = $value;
1062 =head2 inflate_result
1064 Class->inflate_result($result_source, \%me, \%prefetch?)
1068 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1070 =item Returns: A Row object
1074 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1075 database and turn it into row objects call this method.
1077 Extend this method in your Result classes to hook into this process,
1078 for example to rebless the result into a different class.
1080 Reblessing can also be done more easily by setting C<result_class> in
1081 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1083 Different types of results can also be created from a particular
1084 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1088 sub inflate_result {
1089 my ($class, $source, $me, $prefetch) = @_;
1091 my ($source_handle) = $source;
1093 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
1094 $source = $source_handle->resolve
1096 $source_handle = $source->handle
1100 _source_handle => $source_handle,
1101 _column_data => $me,
1103 bless $new, (ref $class || $class);
1106 foreach my $pre (keys %{$prefetch||{}}) {
1107 my $pre_val = $prefetch->{$pre};
1108 my $pre_source = $source->related_source($pre);
1109 $class->throw_exception("Can't prefetch non-existent relationship ${pre}")
1111 if (ref($pre_val->[0]) eq 'ARRAY') { # multi
1114 for my $me_pref (@$pre_val) {
1116 # the collapser currently *could* return bogus elements with all
1117 # columns set to undef
1119 for (values %{$me_pref->[0]}) {
1125 next unless $has_def;
1127 push @pre_objects, $pre_source->result_class->inflate_result(
1128 $pre_source, @$me_pref
1132 $new->related_resultset($pre)->set_cache(\@pre_objects);
1133 } elsif (defined $pre_val->[0]) {
1135 unless ($pre_source->primary_columns == grep { exists $pre_val->[0]{$_}
1136 and !defined $pre_val->[0]{$_} } $pre_source->primary_columns)
1138 $fetched = $pre_source->result_class->inflate_result(
1139 $pre_source, @{$pre_val});
1141 my $accessor = $source->relationship_info($pre)->{attrs}{accessor};
1142 $class->throw_exception("No accessor for prefetched $pre")
1143 unless defined $accessor;
1144 if ($accessor eq 'single') {
1145 $new->{_relationship_data}{$pre} = $fetched;
1146 } elsif ($accessor eq 'filter') {
1147 $new->{_inflated_column}{$pre} = $fetched;
1149 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor '$accessor'");
1151 $new->related_resultset($pre)->set_cache([ $fetched ]);
1155 $new->in_storage (1);
1159 =head2 update_or_insert
1161 $row->update_or_insert
1165 =item Arguments: none
1167 =item Returns: Result of update or insert operation
1171 L</Update>s the object if it's already in the database, according to
1172 L</in_storage>, else L</insert>s it.
1174 =head2 insert_or_update
1176 $obj->insert_or_update
1178 Alias for L</update_or_insert>
1182 sub insert_or_update { shift->update_or_insert(@_) }
1184 sub update_or_insert {
1186 return ($self->in_storage ? $self->update : $self->insert);
1191 my @changed_col_names = $row->is_changed();
1192 if ($row->is_changed()) { ... }
1196 =item Arguments: none
1198 =item Returns: 0|1 or @columnnames
1202 In list context returns a list of columns with uncommited changes, or
1203 in scalar context returns a true value if there are uncommitted
1209 return keys %{shift->{_dirty_columns} || {}};
1212 =head2 is_column_changed
1214 if ($row->is_column_changed('col')) { ... }
1218 =item Arguments: $columname
1224 Returns a true value if the column has uncommitted changes.
1228 sub is_column_changed {
1229 my( $self, $col ) = @_;
1230 return exists $self->{_dirty_columns}->{$col};
1233 =head2 result_source
1235 my $resultsource = $row->result_source;
1239 =item Arguments: none
1241 =item Returns: a ResultSource instance
1245 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1253 $self->_source_handle($_[0]->handle);
1255 $self->_source_handle->resolve;
1259 =head2 register_column
1261 $column_info = { .... };
1262 $class->register_column($column_name, $column_info);
1266 =item Arguments: $columnname, \%columninfo
1268 =item Returns: undefined
1272 Registers a column on the class. If the column_info has an 'accessor'
1273 key, creates an accessor named after the value if defined; if there is
1274 no such key, creates an accessor with the same name as the column
1276 The column_info attributes are described in
1277 L<DBIx::Class::ResultSource/add_columns>
1281 sub register_column {
1282 my ($class, $col, $info) = @_;
1284 if (exists $info->{accessor}) {
1285 return unless defined $info->{accessor};
1286 $acc = [ $info->{accessor}, $col ];
1288 $class->mk_group_accessors('column' => $acc);
1291 =head2 get_from_storage
1293 my $copy = $row->get_from_storage($attrs)
1297 =item Arguments: \%attrs
1299 =item Returns: A Row object
1303 Fetches a fresh copy of the Row object from the database and returns it.
1305 If passed the \%attrs argument, will first apply these attributes to
1306 the resultset used to find the row.
1308 This copy can then be used to compare to an existing row object, to
1309 determine if any changes have been made in the database since it was
1312 To just update your Row object with any latest changes from the
1313 database, use L</discard_changes> instead.
1315 The \%attrs argument should be compatible with
1316 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1320 sub get_from_storage {
1321 my $self = shift @_;
1322 my $attrs = shift @_;
1323 my $resultset = $self->result_source->resultset;
1325 if(defined $attrs) {
1326 $resultset = $resultset->search(undef, $attrs);
1329 return $resultset->find($self->{_orig_ident} || $self->ident_condition);
1332 =head2 discard_changes ($attrs)
1334 Re-selects the row from the database, losing any changes that had
1337 This method can also be used to refresh from storage, retrieving any
1338 changes made since the row was last read from storage.
1340 $attrs is expected to be a hashref of attributes suitable for passing as the
1341 second argument to $resultset->search($cond, $attrs);
1345 sub discard_changes {
1346 my ($self, $attrs) = @_;
1347 delete $self->{_dirty_columns};
1348 return unless $self->in_storage; # Don't reload if we aren't real!
1350 # add a replication default to read from the master only
1351 $attrs = { force_pool => 'master', %{$attrs||{}} };
1353 if( my $current_storage = $self->get_from_storage($attrs)) {
1355 # Set $self to the current.
1356 %$self = %$current_storage;
1358 # Avoid a possible infinite loop with
1359 # sub DESTROY { $_[0]->discard_changes }
1360 bless $current_storage, 'Do::Not::Exist';
1365 $self->in_storage(0);
1371 =head2 throw_exception
1373 See L<DBIx::Class::Schema/throw_exception>.
1377 sub throw_exception {
1380 if (ref $self && ref $self->result_source && $self->result_source->schema) {
1381 $self->result_source->schema->throw_exception(@_)
1384 DBIx::Class::Exception->throw(@_);
1394 =item Arguments: none
1396 =item Returns: A list of primary key values
1400 Returns the primary key(s) for a row. Can't be called as a class method.
1401 Actually implemented in L<DBIx::Class::PK>
1403 =head2 discard_changes
1405 $row->discard_changes
1409 =item Arguments: none
1411 =item Returns: nothing (updates object in-place)
1415 Retrieves and sets the row object data from the database, losing any
1418 This method can also be used to refresh from storage, retrieving any
1419 changes made since the row was last read from storage. Actually
1420 implemented in L<DBIx::Class::PK>
1422 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1423 storage, please kept in mind that if you L</discard_changes> on a row that you
1424 just updated or created, you should wrap the entire bit inside a transaction.
1425 Otherwise you run the risk that you insert or update to the master database
1426 but read from a replicant database that has not yet been updated from the
1427 master. This will result in unexpected results.
1435 Matt S. Trout <mst@shadowcatsystems.co.uk>
1439 You may distribute this code under the same terms as Perl itself.