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) = @_;
109 # create a mock-object so all new/set_column component overrides will run:
110 my $rel_rs = $self->result_source
111 ->related_source($relname)
113 my $new_rel_obj = $rel_rs->new_result($data);
114 my $proc_data = { $new_rel_obj->get_columns };
116 if ($self->__their_pk_needs_us($relname)) {
117 MULTICREATE_DEBUG and warn "MC $self constructing $relname via new_result";
120 elsif ($self->result_source->_pk_depends_on($relname, $proc_data )) {
121 if (! keys %$proc_data) {
122 # there is nothing to search for - blind create
123 MULTICREATE_DEBUG and warn "MC $self constructing default-insert $relname";
126 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new";
127 # this is not *really* find or new, as we don't want to double-new the
128 # data (thus potentially double encoding or whatever)
129 my $exists = $rel_rs->find ($proc_data);
130 return $exists if $exists;
135 my $us = $self->source_name;
136 $self->throw_exception ("'$us' neither depends nor is depended on by '$relname', something is wrong...");
140 sub __their_pk_needs_us { # this should maybe be in resultsource.
141 my ($self, $relname) = @_;
142 my $source = $self->result_source;
143 my $reverse = $source->reverse_relationship_info($relname);
144 my $rel_source = $source->related_source($relname);
145 my $us = { $self->get_columns };
146 foreach my $key (keys %$reverse) {
147 # if their primary key depends on us, then we have to
148 # just create a result and we'll fill it out afterwards
149 return 1 if $rel_source->_pk_depends_on($key, $us);
155 my ($class, $attrs) = @_;
156 $class = ref $class if ref $class;
163 if (my $handle = delete $attrs->{-source_handle}) {
164 $new->_source_handle($handle);
168 if ($source = delete $attrs->{-result_source}) {
169 $new->result_source($source);
172 if (my $related = delete $attrs->{-cols_from_relations}) {
173 @{$new->{_ignore_at_insert}={}}{@$related} = ();
177 $new->throw_exception("attrs must be a hashref")
178 unless ref($attrs) eq 'HASH';
180 my ($related,$inflated);
182 foreach my $key (keys %$attrs) {
183 if (ref $attrs->{$key}) {
184 ## Can we extract this lot to use with update(_or .. ) ?
185 $new->throw_exception("Can't do multi-create without result source")
187 my $info = $source->relationship_info($key);
188 my $acc_type = $info->{attrs}{accessor} || '';
189 if ($acc_type eq 'single') {
190 my $rel_obj = delete $attrs->{$key};
191 if(!Scalar::Util::blessed($rel_obj)) {
192 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
195 if ($rel_obj->in_storage) {
196 $new->{_rel_in_storage}{$key} = 1;
197 $new->set_from_related($key, $rel_obj);
199 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj\n";
202 $related->{$key} = $rel_obj;
205 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
206 my $others = delete $attrs->{$key};
207 my $total = @$others;
209 foreach my $idx (0 .. $#$others) {
210 my $rel_obj = $others->[$idx];
211 if(!Scalar::Util::blessed($rel_obj)) {
212 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
215 if ($rel_obj->in_storage) {
216 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
218 MULTICREATE_DEBUG and
219 warn "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
221 push(@objects, $rel_obj);
223 $related->{$key} = \@objects;
226 elsif ($acc_type eq 'filter') {
227 ## 'filter' should disappear and get merged in with 'single' above!
228 my $rel_obj = delete $attrs->{$key};
229 if(!Scalar::Util::blessed($rel_obj)) {
230 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
232 if ($rel_obj->in_storage) {
233 $new->{_rel_in_storage}{$key} = 1;
236 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj";
238 $inflated->{$key} = $rel_obj;
240 } elsif ($class->has_column($key)
241 && $class->column_info($key)->{_inflate_info}) {
242 $inflated->{$key} = $attrs->{$key};
246 $new->throw_exception("No such column $key on $class")
247 unless $class->has_column($key);
248 $new->store_column($key => $attrs->{$key});
251 $new->{_relationship_data} = $related if $related;
252 $new->{_inflated_column} = $inflated if $inflated;
264 =item Arguments: none
266 =item Returns: The Row object
270 Inserts an object previously created by L</new> into the database if
271 it isn't already in there. Returns the object itself. Requires the
272 object's result source to be set, or the class to have a
273 result_source_instance method. To insert an entirely new row into
274 the database, use C<create> (see L<DBIx::Class::ResultSet/create>).
276 To fetch an uninserted row object, call
277 L<new|DBIx::Class::ResultSet/new> on a resultset.
279 This will also insert any uninserted, related objects held inside this
280 one, see L<DBIx::Class::ResultSet/create> for more details.
286 return $self if $self->in_storage;
287 my $source = $self->result_source;
288 $source ||= $self->result_source($self->result_source_instance)
289 if $self->can('result_source_instance');
290 $self->throw_exception("No result_source set on this object; can't insert")
295 # Check if we stored uninserted relobjs here in new()
296 my %related_stuff = (%{$self->{_relationship_data} || {}},
297 %{$self->{_inflated_column} || {}});
299 # insert what needs to be inserted before us
301 for my $relname (keys %related_stuff) {
302 my $rel_obj = $related_stuff{$relname};
304 if (! $self->{_rel_in_storage}{$relname}) {
305 next unless (Scalar::Util::blessed($rel_obj)
306 && $rel_obj->isa('DBIx::Class::Row'));
308 next unless $source->_pk_depends_on(
309 $relname, { $rel_obj->get_columns }
312 # The guard will save us if we blow out of this scope via die
313 $rollback_guard ||= $source->storage->txn_scope_guard;
315 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
317 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_inflated_columns };
320 # if there are no keys - nothing to search for
321 if (keys %$them and $existing = $self->result_source
322 ->related_source($relname)
326 %{$rel_obj} = %{$existing};
332 $self->{_rel_in_storage}{$relname} = 1;
335 $self->set_from_related($relname, $rel_obj);
336 delete $related_stuff{$relname};
339 # start a transaction here if not started yet and there is more stuff
341 if (keys %related_stuff) {
342 $rollback_guard ||= $source->storage->txn_scope_guard
345 MULTICREATE_DEBUG and do {
346 no warnings 'uninitialized';
347 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
349 my $updated_cols = $source->storage->insert($source, { $self->get_columns });
350 foreach my $col (keys %$updated_cols) {
351 $self->store_column($col, $updated_cols->{$col});
355 my @auto_pri = grep {
356 (not defined $self->get_column($_))
358 (ref($self->get_column($_)) eq 'SCALAR')
359 } $self->primary_columns;
362 MULTICREATE_DEBUG and warn "MC $self fetching missing PKs ".join(', ', @auto_pri)."\n";
363 my $storage = $self->result_source->storage;
364 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
365 unless $storage->can('last_insert_id');
366 my @ids = $storage->last_insert_id($self->result_source,@auto_pri);
367 $self->throw_exception( "Can't get last insert id" )
368 unless (@ids == @auto_pri);
369 $self->store_column($auto_pri[$_] => $ids[$_]) for 0 .. $#ids;
373 $self->{_dirty_columns} = {};
374 $self->{related_resultsets} = {};
376 foreach my $relname (keys %related_stuff) {
377 next unless $source->has_relationship ($relname);
379 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
380 ? @{$related_stuff{$relname}}
381 : $related_stuff{$relname}
385 && Scalar::Util::blessed($cands[0])
386 && $cands[0]->isa('DBIx::Class::Row')
388 my $reverse = $source->reverse_relationship_info($relname);
389 foreach my $obj (@cands) {
390 $obj->set_from_related($_, $self) for keys %$reverse;
391 my $them = { %{$obj->{_relationship_data} || {} }, $obj->get_inflated_columns };
392 if ($self->__their_pk_needs_us($relname)) {
393 if (exists $self->{_ignore_at_insert}{$relname}) {
394 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
396 MULTICREATE_DEBUG and warn "MC $self re-creating $relname $obj";
397 my $re = $self->result_source
398 ->related_source($relname)
402 MULTICREATE_DEBUG and warn "MC $self new $relname $obj";
405 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
412 $self->in_storage(1);
413 delete $self->{_orig_ident};
414 delete $self->{_ignore_at_insert};
415 $rollback_guard->commit if $rollback_guard;
422 $row->in_storage; # Get value
423 $row->in_storage(1); # Set value
427 =item Arguments: none or 1|0
433 Indicates whether the object exists as a row in the database or
434 not. This is set to true when L<DBIx::Class::ResultSet/find>,
435 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
438 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
439 L</delete> on one, sets it to false.
444 my ($self, $val) = @_;
445 $self->{_in_storage} = $val if @_ > 1;
446 return $self->{_in_storage} ? 1 : 0;
451 $row->update(\%columns?)
455 =item Arguments: none or a hashref
457 =item Returns: The Row object
461 Throws an exception if the row object is not yet in the database,
462 according to L</in_storage>.
464 This method issues an SQL UPDATE query to commit any changes to the
465 object to the database if required (see L</get_dirty_columns>).
466 It throws an exception if a proper WHERE clause uniquely identifying
467 the database row can not be constructed (see
468 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
471 Also takes an optional hashref of C<< column_name => value> >> pairs
472 to update on the object first. Be aware that the hashref will be
473 passed to C<set_inflated_columns>, which might edit it in place, so
474 don't rely on it being the same after a call to C<update>. If you
475 need to preserve the hashref, it is sufficient to pass a shallow copy
476 to C<update>, e.g. ( { %{ $href } } )
478 If the values passed or any of the column values set on the object
479 contain scalar references, e.g.:
481 $row->last_modified(\'NOW()');
483 $row->update({ last_modified => \'NOW()' });
485 The update will pass the values verbatim into SQL. (See
486 L<SQL::Abstract> docs). The values in your Row object will NOT change
487 as a result of the update call, if you want the object to be updated
488 with the actual values from the database, call L</discard_changes>
491 $row->update()->discard_changes();
493 To determine before calling this method, which column values have
494 changed and will be updated, call L</get_dirty_columns>.
496 To check if any columns will be updated, call L</is_changed>.
498 To force a column to be updated, call L</make_column_dirty> before
504 my ($self, $upd) = @_;
505 $self->throw_exception( "Not in database" ) unless $self->in_storage;
507 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
509 $self->throw_exception('Unable to update a row with incomplete or no identity')
510 if ! keys %$ident_cond;
512 $self->set_inflated_columns($upd) if $upd;
513 my %to_update = $self->get_dirty_columns;
514 return $self unless keys %to_update;
515 my $rows = $self->result_source->storage->update(
516 $self->result_source, \%to_update, $ident_cond
519 $self->throw_exception( "Can't update ${self}: row not found" );
520 } elsif ($rows > 1) {
521 $self->throw_exception("Can't update ${self}: updated more than one row");
523 $self->{_dirty_columns} = {};
524 $self->{related_resultsets} = {};
525 delete $self->{_orig_ident};
535 =item Arguments: none
537 =item Returns: The Row object
541 Throws an exception if the object is not in the database according to
542 L</in_storage>. Also throws an exception if a proper WHERE clause
543 uniquely identifying the database row can not be constructed (see
544 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
547 The object is still perfectly usable, but L</in_storage> will
548 now return 0 and the object must be reinserted using L</insert>
549 before it can be used to L</update> the row again.
551 If you delete an object in a class with a C<has_many> relationship, an
552 attempt is made to delete all the related objects as well. To turn
553 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
554 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
555 database-level cascade or restrict will take precedence over a
556 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
557 main row first> and only then attempts to delete any remaining related
560 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
561 and the transaction subsequently fails, the row object will remain marked as
562 not being in storage. If you know for a fact that the object is still in
563 storage (i.e. by inspecting the cause of the transaction's failure), you can
564 use C<< $obj->in_storage(1) >> to restore consistency between the object and
565 the database. This would allow a subsequent C<< $obj->delete >> to work
568 See also L<DBIx::Class::ResultSet/delete>.
575 $self->throw_exception( "Not in database" ) unless $self->in_storage;
577 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
578 $self->throw_exception('Unable to delete a row with incomplete or no identity')
579 if ! keys %$ident_cond;
581 $self->result_source->storage->delete(
582 $self->result_source, $ident_cond
585 delete $self->{_orig_ident};
586 $self->in_storage(undef);
589 $self->throw_exception("Can't do class delete without a ResultSource instance")
590 unless $self->can('result_source_instance');
591 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
592 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
593 $self->result_source_instance->resultset->search(@_)->delete;
600 my $val = $row->get_column($col);
604 =item Arguments: $columnname
606 =item Returns: The value of the column
610 Throws an exception if the column name given doesn't exist according
613 Returns a raw column value from the row object, if it has already
614 been fetched from the database or set by an accessor.
616 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
617 will be deflated and returned.
619 Note that if you used the C<columns> or the C<select/as>
620 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
621 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
622 this method will return C<undef> even if the database contains some value.
624 To retrieve all loaded column values as a hash, use L</get_columns>.
629 my ($self, $column) = @_;
630 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
631 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
632 if (exists $self->{_inflated_column}{$column}) {
633 return $self->store_column($column,
634 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
636 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
640 =head2 has_column_loaded
642 if ( $row->has_column_loaded($col) ) {
643 print "$col has been loaded from db";
648 =item Arguments: $columnname
654 Returns a true value if the column value has been loaded from the
655 database (or set locally).
659 sub has_column_loaded {
660 my ($self, $column) = @_;
661 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
662 return 1 if exists $self->{_inflated_column}{$column};
663 return exists $self->{_column_data}{$column};
668 my %data = $row->get_columns;
672 =item Arguments: none
674 =item Returns: A hash of columnname, value pairs.
678 Returns all loaded column data as a hash, containing raw values. To
679 get just one value for a particular column, use L</get_column>.
681 See L</get_inflated_columns> to get the inflated values.
687 if (exists $self->{_inflated_column}) {
688 foreach my $col (keys %{$self->{_inflated_column}}) {
689 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
690 unless exists $self->{_column_data}{$col};
693 return %{$self->{_column_data}};
696 =head2 get_dirty_columns
698 my %data = $row->get_dirty_columns;
702 =item Arguments: none
704 =item Returns: A hash of column, value pairs
708 Only returns the column, value pairs for those columns that have been
709 changed on this object since the last L</update> or L</insert> call.
711 See L</get_columns> to fetch all column/value pairs.
715 sub get_dirty_columns {
717 return map { $_ => $self->{_column_data}{$_} }
718 keys %{$self->{_dirty_columns}};
721 =head2 make_column_dirty
723 $row->make_column_dirty($col)
727 =item Arguments: $columnname
729 =item Returns: undefined
733 Throws an exception if the column does not exist.
735 Marks a column as having been changed regardless of whether it has
739 sub make_column_dirty {
740 my ($self, $column) = @_;
742 $self->throw_exception( "No such column '${column}'" )
743 unless exists $self->{_column_data}{$column} || $self->has_column($column);
745 # the entire clean/dirty code relies on exists, not on true/false
746 return 1 if exists $self->{_dirty_columns}{$column};
748 $self->{_dirty_columns}{$column} = 1;
750 # if we are just now making the column dirty, and if there is an inflated
751 # value, force it over the deflated one
752 if (exists $self->{_inflated_column}{$column}) {
753 $self->store_column($column,
754 $self->_deflated_column(
755 $column, $self->{_inflated_column}{$column}
761 =head2 get_inflated_columns
763 my %inflated_data = $obj->get_inflated_columns;
767 =item Arguments: none
769 =item Returns: A hash of column, object|value pairs
773 Returns a hash of all column keys and associated values. Values for any
774 columns set to use inflation will be inflated and returns as objects.
776 See L</get_columns> to get the uninflated values.
778 See L<DBIx::Class::InflateColumn> for how to setup inflation.
782 sub get_inflated_columns {
785 my %loaded_colinfo = (map
786 { $_ => $self->column_info($_) }
787 (grep { $self->has_column_loaded($_) } $self->columns)
791 for my $col (keys %loaded_colinfo) {
792 if (exists $loaded_colinfo{$col}{accessor}) {
793 my $acc = $loaded_colinfo{$col}{accessor};
794 $inflated{$col} = $self->$acc if defined $acc;
797 $inflated{$col} = $self->$col;
801 # return all loaded columns with the inflations overlayed on top
802 return ($self->get_columns, %inflated);
805 sub _is_column_numeric {
806 my ($self, $column) = @_;
807 my $colinfo = $self->column_info ($column);
809 # cache for speed (the object may *not* have a resultsource instance)
810 if (not defined $colinfo->{is_numeric} && $self->_source_handle) {
811 $colinfo->{is_numeric} =
812 $self->result_source->schema->storage->is_datatype_numeric ($colinfo->{data_type})
818 return $colinfo->{is_numeric};
823 $row->set_column($col => $val);
827 =item Arguments: $columnname, $value
829 =item Returns: $value
833 Sets a raw column value. If the new value is different from the old one,
834 the column is marked as dirty for when you next call L</update>.
836 If passed an object or reference as a value, this method will happily
837 attempt to store it, and a later L</insert> or L</update> will try and
838 stringify/numify as appropriate. To set an object to be deflated
839 instead, see L</set_inflated_columns>.
844 my ($self, $column, $new_value) = @_;
846 # if we can't get an ident condition on first try - mark the object as unidentifiable
847 $self->{_orig_ident} ||= (eval { $self->ident_condition }) || {};
849 my $old_value = $self->get_column($column);
850 $new_value = $self->store_column($column, $new_value);
853 if (!$self->in_storage) { # no point tracking dirtyness on uninserted data
856 elsif (defined $old_value xor defined $new_value) {
859 elsif (not defined $old_value) { # both undef
862 elsif ($old_value eq $new_value) {
865 else { # do a numeric comparison if datatype allows it
866 if ($self->_is_column_numeric($column)) {
867 $dirty = $old_value != $new_value;
874 # sadly the update code just checks for keys, not for their value
875 $self->{_dirty_columns}{$column} = 1 if $dirty;
877 # XXX clear out the relation cache for this column
878 delete $self->{related_resultsets}{$column};
885 $row->set_columns({ $col => $val, ... });
889 =item Arguments: \%columndata
891 =item Returns: The Row object
895 Sets multiple column, raw value pairs at once.
897 Works as L</set_column>.
902 my ($self,$data) = @_;
903 foreach my $col (keys %$data) {
904 $self->set_column($col,$data->{$col});
909 =head2 set_inflated_columns
911 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
915 =item Arguments: \%columndata
917 =item Returns: The Row object
921 Sets more than one column value at once. Any inflated values are
922 deflated and the raw values stored.
924 Any related values passed as Row objects, using the relation name as a
925 key, are reduced to the appropriate foreign key values and stored. If
926 instead of related row objects, a hashref of column, value data is
927 passed, will create the related object first then store.
929 Will even accept arrayrefs of data as a value to a
930 L<DBIx::Class::Relationship/has_many> key, and create the related
931 objects if necessary.
933 Be aware that the input hashref might be edited in place, so don't rely
934 on it being the same after a call to C<set_inflated_columns>. If you
935 need to preserve the hashref, it is sufficient to pass a shallow copy
936 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
938 See also L<DBIx::Class::Relationship::Base/set_from_related>.
942 sub set_inflated_columns {
943 my ( $self, $upd ) = @_;
944 foreach my $key (keys %$upd) {
945 if (ref $upd->{$key}) {
946 my $info = $self->relationship_info($key);
947 my $acc_type = $info->{attrs}{accessor} || '';
948 if ($acc_type eq 'single') {
949 my $rel = delete $upd->{$key};
950 $self->set_from_related($key => $rel);
951 $self->{_relationship_data}{$key} = $rel;
953 elsif ($acc_type eq 'multi') {
954 $self->throw_exception(
955 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
958 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
959 $self->set_inflated_column($key, delete $upd->{$key});
963 $self->set_columns($upd);
968 my $copy = $orig->copy({ change => $to, ... });
972 =item Arguments: \%replacementdata
974 =item Returns: The Row object copy
978 Inserts a new row into the database, as a copy of the original
979 object. If a hashref of replacement data is supplied, these will take
980 precedence over data in the original. Also any columns which have
981 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
982 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
983 so that the database can insert its own autoincremented values into
986 Relationships will be followed by the copy procedure B<only> if the
987 relationship specifies a true value for its
988 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
989 is set by default on C<has_many> relationships and unset on all others.
994 my ($self, $changes) = @_;
996 my $col_data = { %{$self->{_column_data}} };
997 foreach my $col (keys %$col_data) {
998 delete $col_data->{$col}
999 if $self->result_source->column_info($col)->{is_auto_increment};
1002 my $new = { _column_data => $col_data };
1003 bless $new, ref $self;
1005 $new->result_source($self->result_source);
1006 $new->set_inflated_columns($changes);
1009 # Its possible we'll have 2 relations to the same Source. We need to make
1010 # sure we don't try to insert the same row twice else we'll violate unique
1012 my $rels_copied = {};
1014 foreach my $rel ($self->result_source->relationships) {
1015 my $rel_info = $self->result_source->relationship_info($rel);
1017 next unless $rel_info->{attrs}{cascade_copy};
1019 my $resolved = $self->result_source->_resolve_condition(
1020 $rel_info->{cond}, $rel, $new
1023 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1024 foreach my $related ($self->search_related($rel)) {
1025 my $id_str = join("\0", $related->id);
1026 next if $copied->{$id_str};
1027 $copied->{$id_str} = 1;
1028 my $rel_copy = $related->copy($resolved);
1037 $row->store_column($col => $val);
1041 =item Arguments: $columnname, $value
1043 =item Returns: The value sent to storage
1047 Set a raw value for a column without marking it as changed. This
1048 method is used internally by L</set_column> which you should probably
1051 This is the lowest level at which data is set on a row object,
1052 extend this method to catch all data setting methods.
1057 my ($self, $column, $value) = @_;
1058 $self->throw_exception( "No such column '${column}'" )
1059 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1060 $self->throw_exception( "set_column called for ${column} without value" )
1062 return $self->{_column_data}{$column} = $value;
1065 =head2 inflate_result
1067 Class->inflate_result($result_source, \%me, \%prefetch?)
1071 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1073 =item Returns: A Row object
1077 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1078 database and turn it into row objects call this method.
1080 Extend this method in your Result classes to hook into this process,
1081 for example to rebless the result into a different class.
1083 Reblessing can also be done more easily by setting C<result_class> in
1084 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1086 Different types of results can also be created from a particular
1087 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1091 sub inflate_result {
1092 my ($class, $source, $me, $prefetch) = @_;
1094 my ($source_handle) = $source;
1096 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
1097 $source = $source_handle->resolve
1100 $source_handle = $source->handle
1104 _source_handle => $source_handle,
1105 _column_data => $me,
1107 bless $new, (ref $class || $class);
1109 foreach my $pre (keys %{$prefetch||{}}) {
1111 my $pre_source = $source->related_source($pre)
1112 or $class->throw_exception("Can't prefetch non-existent relationship ${pre}");
1114 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1115 or $class->throw_exception("No accessor for prefetched $pre");
1118 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1119 @pre_vals = @{$prefetch->{$pre}};
1121 elsif ($accessor eq 'multi') {
1122 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor 'multi'");
1125 @pre_vals = $prefetch->{$pre};
1129 for my $me_pref (@pre_vals) {
1131 # FIXME - this should not be necessary
1132 # the collapser currently *could* return bogus elements with all
1133 # columns set to undef
1135 for (values %{$me_pref->[0]}) {
1141 next unless $has_def;
1143 push @pre_objects, $pre_source->result_class->inflate_result(
1144 $pre_source, @$me_pref
1148 if ($accessor eq 'single') {
1149 $new->{_relationship_data}{$pre} = $pre_objects[0];
1151 elsif ($accessor eq 'filter') {
1152 $new->{_inflated_column}{$pre} = $pre_objects[0];
1155 $new->related_resultset($pre)->set_cache(\@pre_objects);
1158 $new->in_storage (1);
1162 =head2 update_or_insert
1164 $row->update_or_insert
1168 =item Arguments: none
1170 =item Returns: Result of update or insert operation
1174 L</Update>s the object if it's already in the database, according to
1175 L</in_storage>, else L</insert>s it.
1177 =head2 insert_or_update
1179 $obj->insert_or_update
1181 Alias for L</update_or_insert>
1185 sub insert_or_update { shift->update_or_insert(@_) }
1187 sub update_or_insert {
1189 return ($self->in_storage ? $self->update : $self->insert);
1194 my @changed_col_names = $row->is_changed();
1195 if ($row->is_changed()) { ... }
1199 =item Arguments: none
1201 =item Returns: 0|1 or @columnnames
1205 In list context returns a list of columns with uncommited changes, or
1206 in scalar context returns a true value if there are uncommitted
1212 return keys %{shift->{_dirty_columns} || {}};
1215 =head2 is_column_changed
1217 if ($row->is_column_changed('col')) { ... }
1221 =item Arguments: $columname
1227 Returns a true value if the column has uncommitted changes.
1231 sub is_column_changed {
1232 my( $self, $col ) = @_;
1233 return exists $self->{_dirty_columns}->{$col};
1236 =head2 result_source
1238 my $resultsource = $row->result_source;
1242 =item Arguments: none
1244 =item Returns: a ResultSource instance
1248 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1256 $self->_source_handle($_[0]->handle);
1258 $self->_source_handle->resolve;
1262 =head2 register_column
1264 $column_info = { .... };
1265 $class->register_column($column_name, $column_info);
1269 =item Arguments: $columnname, \%columninfo
1271 =item Returns: undefined
1275 Registers a column on the class. If the column_info has an 'accessor'
1276 key, creates an accessor named after the value if defined; if there is
1277 no such key, creates an accessor with the same name as the column
1279 The column_info attributes are described in
1280 L<DBIx::Class::ResultSource/add_columns>
1284 sub register_column {
1285 my ($class, $col, $info) = @_;
1287 if (exists $info->{accessor}) {
1288 return unless defined $info->{accessor};
1289 $acc = [ $info->{accessor}, $col ];
1291 $class->mk_group_accessors('column' => $acc);
1294 =head2 get_from_storage
1296 my $copy = $row->get_from_storage($attrs)
1300 =item Arguments: \%attrs
1302 =item Returns: A Row object
1306 Fetches a fresh copy of the Row object from the database and returns it.
1307 Throws an exception if a proper WHERE clause identifying the database row
1308 can not be constructed (i.e. if the original object does not contain its
1310 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1311 ). If passed the \%attrs argument, will first apply these attributes to
1312 the resultset used to find the row.
1314 This copy can then be used to compare to an existing row object, to
1315 determine if any changes have been made in the database since it was
1318 To just update your Row object with any latest changes from the
1319 database, use L</discard_changes> instead.
1321 The \%attrs argument should be compatible with
1322 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1326 sub get_from_storage {
1327 my $self = shift @_;
1328 my $attrs = shift @_;
1329 my $resultset = $self->result_source->resultset;
1331 if(defined $attrs) {
1332 $resultset = $resultset->search(undef, $attrs);
1335 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
1337 $self->throw_exception('Unable to requery a row with incomplete or no identity')
1338 if ! keys %$ident_cond;
1340 return $resultset->find($ident_cond);
1343 =head2 discard_changes ($attrs)
1345 Re-selects the row from the database, losing any changes that had
1346 been made. Throws an exception if a proper WHERE clause identifying
1347 the database row can not be constructed (i.e. if the original object
1348 does not contain its entire
1349 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1352 This method can also be used to refresh from storage, retrieving any
1353 changes made since the row was last read from storage.
1355 $attrs is expected to be a hashref of attributes suitable for passing as the
1356 second argument to $resultset->search($cond, $attrs);
1360 sub discard_changes {
1361 my ($self, $attrs) = @_;
1362 delete $self->{_dirty_columns};
1363 return unless $self->in_storage; # Don't reload if we aren't real!
1365 # add a replication default to read from the master only
1366 $attrs = { force_pool => 'master', %{$attrs||{}} };
1368 if( my $current_storage = $self->get_from_storage($attrs)) {
1370 # Set $self to the current.
1371 %$self = %$current_storage;
1373 # Avoid a possible infinite loop with
1374 # sub DESTROY { $_[0]->discard_changes }
1375 bless $current_storage, 'Do::Not::Exist';
1380 $self->in_storage(0);
1386 =head2 throw_exception
1388 See L<DBIx::Class::Schema/throw_exception>.
1392 sub throw_exception {
1395 if (ref $self && ref $self->result_source && $self->result_source->schema) {
1396 $self->result_source->schema->throw_exception(@_)
1399 DBIx::Class::Exception->throw(@_);
1409 =item Arguments: none
1411 =item Returns: A list of primary key values
1415 Returns the primary key(s) for a row. Can't be called as a class method.
1416 Actually implemented in L<DBIx::Class::PK>
1418 =head2 discard_changes
1420 $row->discard_changes
1424 =item Arguments: none
1426 =item Returns: nothing (updates object in-place)
1430 Retrieves and sets the row object data from the database, losing any
1433 This method can also be used to refresh from storage, retrieving any
1434 changes made since the row was last read from storage. Actually
1435 implemented in L<DBIx::Class::PK>
1437 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1438 storage, please kept in mind that if you L</discard_changes> on a row that you
1439 just updated or created, you should wrap the entire bit inside a transaction.
1440 Otherwise you run the risk that you insert or update to the master database
1441 but read from a replicant database that has not yet been updated from the
1442 master. This will result in unexpected results.
1450 Matt S. Trout <mst@shadowcatsystems.co.uk>
1454 You may distribute this code under the same terms as Perl itself.