1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
8 use DBIx::Class::Exception;
9 use Scalar::Util 'blessed';
19 $ENV{DBIC_MULTICREATE_DEBUG}
24 __PACKAGE__->mk_group_accessors('simple' => qw/_source_handle/);
28 DBIx::Class::Row - Basic row methods
34 This class is responsible for defining and doing basic operations on rows
35 derived from L<DBIx::Class::ResultSource> objects.
37 Row objects are returned from L<DBIx::Class::ResultSet>s using the
38 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
39 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
40 as well as invocations of 'single' (
41 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
42 L<has_one|DBIx::Class::Relationship/has_one> or
43 L<might_have|DBIx::Class::Relationship/might_have>)
44 relationship accessors of L<DBIx::Class::Row> objects.
50 my $row = My::Class->new(\%attrs);
52 my $row = $schema->resultset('MySource')->new(\%colsandvalues);
56 =item Arguments: \%attrs or \%colsandvalues
58 =item Returns: A Row object
62 While you can create a new row object by calling C<new> directly on
63 this class, you are better off calling it on a
64 L<DBIx::Class::ResultSet> object.
66 When calling it directly, you will not get a complete, usable row
67 object until you pass or set the C<source_handle> attribute, to a
68 L<DBIx::Class::ResultSource> instance that is attached to a
69 L<DBIx::Class::Schema> with a valid connection.
71 C<$attrs> is a hashref of column name, value data. It can also contain
72 some other attributes such as the C<source_handle>.
74 Passing an object, or an arrayref of objects as a value will call
75 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
76 passed a hashref or an arrayref of hashrefs as the value, these will
77 be turned into objects via new_related, and treated as if you had
80 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
82 Please note that if a value is not passed to new, no value will be sent
83 in the SQL INSERT call, and the column will therefore assume whatever
84 default value was specified in your database. While DBIC will retrieve the
85 value of autoincrement columns, it will never make an explicit database
86 trip to retrieve default values assigned by the RDBMS. You can explicitly
87 request that all values be fetched back from the database by calling
88 L</discard_changes>, or you can supply an explicit C<undef> to columns
89 with NULL as the default, and save yourself a SELECT.
93 The behavior described above will backfire if you use a foreign key column
94 with a database-defined default. If you call the relationship accessor on
95 an object that doesn't have a set value for the FK column, DBIC will throw
96 an exception, as it has no way of knowing the PK of the related object (if
101 ## 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().
102 ## This only works because DBIC doesnt yet care to check whether the new_related objects have been passed all their mandatory columns
103 ## When doing the later insert, we need to make sure the PKs are set.
104 ## using _relationship_data in new and funky ways..
105 ## check Relationship::CascadeActions and Relationship::Accessor for compat
108 sub __new_related_find_or_new_helper {
109 my ($self, $relname, $data) = @_;
111 my $rsrc = $self->result_source;
113 # create a mock-object so all new/set_column component overrides will run:
114 my $rel_rs = $rsrc->related_source($relname)->resultset;
115 my $new_rel_obj = $rel_rs->new_result($data);
116 my $proc_data = { $new_rel_obj->get_columns };
118 if ($self->__their_pk_needs_us($relname)) {
119 MULTICREATE_DEBUG and warn "MC $self constructing $relname via new_result";
122 elsif ($rsrc->_pk_depends_on($relname, $proc_data )) {
123 if (! keys %$proc_data) {
124 # there is nothing to search for - blind create
125 MULTICREATE_DEBUG and warn "MC $self constructing default-insert $relname";
128 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new";
129 # this is not *really* find or new, as we don't want to double-new the
130 # data (thus potentially double encoding or whatever)
131 my $exists = $rel_rs->find ($proc_data);
132 return $exists if $exists;
137 my $us = $rsrc->source_name;
138 $self->throw_exception ("'$us' neither depends nor is depended on by '$relname', something is wrong...");
142 sub __their_pk_needs_us { # this should maybe be in resultsource.
143 my ($self, $relname) = @_;
144 my $source = $self->result_source;
145 my $reverse = $source->reverse_relationship_info($relname);
146 my $rel_source = $source->related_source($relname);
147 my $us = { $self->get_columns };
148 foreach my $key (keys %$reverse) {
149 # if their primary key depends on us, then we have to
150 # just create a result and we'll fill it out afterwards
151 return 1 if $rel_source->_pk_depends_on($key, $us);
157 my ($class, $attrs) = @_;
158 $class = ref $class if ref $class;
165 if (my $handle = delete $attrs->{-source_handle}) {
166 $new->_source_handle($handle);
170 if ($source = delete $attrs->{-result_source}) {
171 $new->result_source($source);
174 if (my $related = delete $attrs->{-cols_from_relations}) {
175 @{$new->{_ignore_at_insert}={}}{@$related} = ();
179 $new->throw_exception("attrs must be a hashref")
180 unless ref($attrs) eq 'HASH';
182 my ($related,$inflated);
184 foreach my $key (keys %$attrs) {
185 if (ref $attrs->{$key}) {
186 ## Can we extract this lot to use with update(_or .. ) ?
187 $new->throw_exception("Can't do multi-create without result source")
189 my $info = $source->relationship_info($key);
190 my $acc_type = $info->{attrs}{accessor} || '';
191 if ($acc_type eq 'single') {
192 my $rel_obj = delete $attrs->{$key};
193 if(!blessed $rel_obj) {
194 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
197 if ($rel_obj->in_storage) {
198 $new->{_rel_in_storage}{$key} = 1;
199 $new->set_from_related($key, $rel_obj);
201 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj\n";
204 $related->{$key} = $rel_obj;
207 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
208 my $others = delete $attrs->{$key};
209 my $total = @$others;
211 foreach my $idx (0 .. $#$others) {
212 my $rel_obj = $others->[$idx];
213 if(!blessed $rel_obj) {
214 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
217 if ($rel_obj->in_storage) {
218 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
220 MULTICREATE_DEBUG and
221 warn "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
223 push(@objects, $rel_obj);
225 $related->{$key} = \@objects;
228 elsif ($acc_type eq 'filter') {
229 ## 'filter' should disappear and get merged in with 'single' above!
230 my $rel_obj = delete $attrs->{$key};
231 if(!blessed $rel_obj) {
232 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
234 if ($rel_obj->in_storage) {
235 $new->{_rel_in_storage}{$key} = 1;
238 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj";
240 $inflated->{$key} = $rel_obj;
242 } elsif ($class->has_column($key)
243 && $class->column_info($key)->{_inflate_info}) {
244 $inflated->{$key} = $attrs->{$key};
248 $new->throw_exception("No such column $key on $class")
249 unless $class->has_column($key);
250 $new->store_column($key => $attrs->{$key});
253 $new->{_relationship_data} = $related if $related;
254 $new->{_inflated_column} = $inflated if $inflated;
266 =item Arguments: none
268 =item Returns: The Row object
272 Inserts an object previously created by L</new> into the database if
273 it isn't already in there. Returns the object itself. Requires the
274 object's result source to be set, or the class to have a
275 result_source_instance method. To insert an entirely new row into
276 the database, use C<create> (see L<DBIx::Class::ResultSet/create>).
278 To fetch an uninserted row object, call
279 L<new|DBIx::Class::ResultSet/new> on a resultset.
281 This will also insert any uninserted, related objects held inside this
282 one, see L<DBIx::Class::ResultSet/create> for more details.
288 return $self if $self->in_storage;
289 my $source = $self->result_source;
290 $source ||= $self->result_source($self->result_source_instance)
291 if $self->can('result_source_instance');
292 $self->throw_exception("No result_source set on this object; can't insert")
297 # Check if we stored uninserted relobjs here in new()
298 my %related_stuff = (%{$self->{_relationship_data} || {}},
299 %{$self->{_inflated_column} || {}});
301 # insert what needs to be inserted before us
303 for my $relname (keys %related_stuff) {
304 my $rel_obj = $related_stuff{$relname};
306 if (! $self->{_rel_in_storage}{$relname}) {
307 next unless (blessed $rel_obj && $rel_obj->isa('DBIx::Class::Row'));
309 next unless $source->_pk_depends_on(
310 $relname, { $rel_obj->get_columns }
313 # The guard will save us if we blow out of this scope via die
314 $rollback_guard ||= $source->storage->txn_scope_guard;
316 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
318 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_columns };
321 # if there are no keys - nothing to search for
322 if (keys %$them and $existing = $self->result_source
323 ->related_source($relname)
327 %{$rel_obj} = %{$existing};
333 $self->{_rel_in_storage}{$relname} = 1;
336 $self->set_from_related($relname, $rel_obj);
337 delete $related_stuff{$relname};
340 # start a transaction here if not started yet and there is more stuff
342 if (keys %related_stuff) {
343 $rollback_guard ||= $source->storage->txn_scope_guard
349 for ($self->primary_columns) {
351 not defined $self->get_column($_)
353 (ref($self->get_column($_)) eq 'SCALAR')
355 my $col_info = $source->column_info($_);
356 $auto_pri{$_} = $auto_idx++ unless $col_info->{auto_nextval}; # auto_nextval's are pre-fetched in the storage
360 MULTICREATE_DEBUG and do {
361 no warnings 'uninitialized';
362 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
364 my $updated_cols = $source->storage->insert(
366 { $self->get_columns },
367 (keys %auto_pri) && $source->storage->_supports_insert_returning
368 ? { returning => [ sort { $auto_pri{$a} <=> $auto_pri{$b} } keys %auto_pri ] }
373 foreach my $col (keys %$updated_cols) {
374 $self->store_column($col, $updated_cols->{$col});
375 delete $auto_pri{$col};
378 if (keys %auto_pri) {
379 my @missing = sort { $auto_pri{$a} <=> $auto_pri{$b} } keys %auto_pri;
380 MULTICREATE_DEBUG and warn "MC $self fetching missing PKs ".join(', ', @missing )."\n";
381 my $storage = $self->result_source->storage;
382 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
383 unless $storage->can('last_insert_id');
384 my @ids = $storage->last_insert_id($self->result_source, @missing);
385 $self->throw_exception( "Can't get last insert id" )
386 unless (@ids == @missing);
387 $self->store_column($missing[$_] => $ids[$_]) for 0 .. $#missing;
390 $self->{_dirty_columns} = {};
391 $self->{related_resultsets} = {};
393 foreach my $relname (keys %related_stuff) {
394 next unless $source->has_relationship ($relname);
396 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
397 ? @{$related_stuff{$relname}}
398 : $related_stuff{$relname}
401 if (@cands && blessed $cands[0] && $cands[0]->isa('DBIx::Class::Row')
403 my $reverse = $source->reverse_relationship_info($relname);
404 foreach my $obj (@cands) {
405 $obj->set_from_related($_, $self) for keys %$reverse;
406 if ($self->__their_pk_needs_us($relname)) {
407 if (exists $self->{_ignore_at_insert}{$relname}) {
408 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
411 MULTICREATE_DEBUG and warn "MC $self inserting $relname $obj";
415 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
422 $self->in_storage(1);
423 delete $self->{_orig_ident};
424 delete $self->{_ignore_at_insert};
425 $rollback_guard->commit if $rollback_guard;
432 $row->in_storage; # Get value
433 $row->in_storage(1); # Set value
437 =item Arguments: none or 1|0
443 Indicates whether the object exists as a row in the database or
444 not. This is set to true when L<DBIx::Class::ResultSet/find>,
445 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
448 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
449 L</delete> on one, sets it to false.
454 my ($self, $val) = @_;
455 $self->{_in_storage} = $val if @_ > 1;
456 return $self->{_in_storage} ? 1 : 0;
461 $row->update(\%columns?)
465 =item Arguments: none or a hashref
467 =item Returns: The Row object
471 Throws an exception if the row object is not yet in the database,
472 according to L</in_storage>.
474 This method issues an SQL UPDATE query to commit any changes to the
475 object to the database if required (see L</get_dirty_columns>).
476 It throws an exception if a proper WHERE clause uniquely identifying
477 the database row can not be constructed (see
478 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
481 Also takes an optional hashref of C<< column_name => value >> pairs
482 to update on the object first. Be aware that the hashref will be
483 passed to C<set_inflated_columns>, which might edit it in place, so
484 don't rely on it being the same after a call to C<update>. If you
485 need to preserve the hashref, it is sufficient to pass a shallow copy
486 to C<update>, e.g. ( { %{ $href } } )
488 If the values passed or any of the column values set on the object
489 contain scalar references, e.g.:
491 $row->last_modified(\'NOW()');
493 $row->update({ last_modified => \'NOW()' });
495 The update will pass the values verbatim into SQL. (See
496 L<SQL::Abstract> docs). The values in your Row object will NOT change
497 as a result of the update call, if you want the object to be updated
498 with the actual values from the database, call L</discard_changes>
501 $row->update()->discard_changes();
503 To determine before calling this method, which column values have
504 changed and will be updated, call L</get_dirty_columns>.
506 To check if any columns will be updated, call L</is_changed>.
508 To force a column to be updated, call L</make_column_dirty> before
514 my ($self, $upd) = @_;
516 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
518 $self->set_inflated_columns($upd) if $upd;
519 my %to_update = $self->get_dirty_columns;
520 return $self unless keys %to_update;
522 $self->throw_exception( "Not in database" ) unless $self->in_storage;
524 $self->throw_exception('Unable to update a row with incomplete or no identity')
525 if ! keys %$ident_cond;
527 my $rows = $self->result_source->storage->update(
528 $self->result_source, \%to_update, $ident_cond
531 $self->throw_exception( "Can't update ${self}: row not found" );
532 } elsif ($rows > 1) {
533 $self->throw_exception("Can't update ${self}: updated more than one row");
535 $self->{_dirty_columns} = {};
536 $self->{related_resultsets} = {};
537 delete $self->{_orig_ident};
547 =item Arguments: none
549 =item Returns: The Row object
553 Throws an exception if the object is not in the database according to
554 L</in_storage>. Also throws an exception if a proper WHERE clause
555 uniquely identifying the database row can not be constructed (see
556 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
559 The object is still perfectly usable, but L</in_storage> will
560 now return 0 and the object must be reinserted using L</insert>
561 before it can be used to L</update> the row again.
563 If you delete an object in a class with a C<has_many> relationship, an
564 attempt is made to delete all the related objects as well. To turn
565 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
566 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
567 database-level cascade or restrict will take precedence over a
568 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
569 main row first> and only then attempts to delete any remaining related
572 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
573 and the transaction subsequently fails, the row object will remain marked as
574 not being in storage. If you know for a fact that the object is still in
575 storage (i.e. by inspecting the cause of the transaction's failure), you can
576 use C<< $obj->in_storage(1) >> to restore consistency between the object and
577 the database. This would allow a subsequent C<< $obj->delete >> to work
580 See also L<DBIx::Class::ResultSet/delete>.
587 $self->throw_exception( "Not in database" ) unless $self->in_storage;
589 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
590 $self->throw_exception('Unable to delete a row with incomplete or no identity')
591 if ! keys %$ident_cond;
593 $self->result_source->storage->delete(
594 $self->result_source, $ident_cond
597 delete $self->{_orig_ident};
598 $self->in_storage(undef);
601 $self->throw_exception("Can't do class delete without a ResultSource instance")
602 unless $self->can('result_source_instance');
603 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
604 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
605 $self->result_source_instance->resultset->search(@_)->delete;
612 my $val = $row->get_column($col);
616 =item Arguments: $columnname
618 =item Returns: The value of the column
622 Throws an exception if the column name given doesn't exist according
625 Returns a raw column value from the row object, if it has already
626 been fetched from the database or set by an accessor.
628 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
629 will be deflated and returned.
631 Note that if you used the C<columns> or the C<select/as>
632 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
633 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
634 this method will return C<undef> even if the database contains some value.
636 To retrieve all loaded column values as a hash, use L</get_columns>.
641 my ($self, $column) = @_;
642 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
643 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
644 if (exists $self->{_inflated_column}{$column}) {
645 return $self->store_column($column,
646 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
648 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
652 =head2 has_column_loaded
654 if ( $row->has_column_loaded($col) ) {
655 print "$col has been loaded from db";
660 =item Arguments: $columnname
666 Returns a true value if the column value has been loaded from the
667 database (or set locally).
671 sub has_column_loaded {
672 my ($self, $column) = @_;
673 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
674 return 1 if exists $self->{_inflated_column}{$column};
675 return exists $self->{_column_data}{$column};
680 my %data = $row->get_columns;
684 =item Arguments: none
686 =item Returns: A hash of columnname, value pairs.
690 Returns all loaded column data as a hash, containing raw values. To
691 get just one value for a particular column, use L</get_column>.
693 See L</get_inflated_columns> to get the inflated values.
699 if (exists $self->{_inflated_column}) {
700 foreach my $col (keys %{$self->{_inflated_column}}) {
701 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
702 unless exists $self->{_column_data}{$col};
705 return %{$self->{_column_data}};
708 =head2 get_dirty_columns
710 my %data = $row->get_dirty_columns;
714 =item Arguments: none
716 =item Returns: A hash of column, value pairs
720 Only returns the column, value pairs for those columns that have been
721 changed on this object since the last L</update> or L</insert> call.
723 See L</get_columns> to fetch all column/value pairs.
727 sub get_dirty_columns {
729 return map { $_ => $self->{_column_data}{$_} }
730 keys %{$self->{_dirty_columns}};
733 =head2 make_column_dirty
735 $row->make_column_dirty($col)
739 =item Arguments: $columnname
741 =item Returns: undefined
745 Throws an exception if the column does not exist.
747 Marks a column as having been changed regardless of whether it has
751 sub make_column_dirty {
752 my ($self, $column) = @_;
754 $self->throw_exception( "No such column '${column}'" )
755 unless exists $self->{_column_data}{$column} || $self->has_column($column);
757 # the entire clean/dirty code relies on exists, not on true/false
758 return 1 if exists $self->{_dirty_columns}{$column};
760 $self->{_dirty_columns}{$column} = 1;
762 # if we are just now making the column dirty, and if there is an inflated
763 # value, force it over the deflated one
764 if (exists $self->{_inflated_column}{$column}) {
765 $self->store_column($column,
766 $self->_deflated_column(
767 $column, $self->{_inflated_column}{$column}
773 =head2 get_inflated_columns
775 my %inflated_data = $obj->get_inflated_columns;
779 =item Arguments: none
781 =item Returns: A hash of column, object|value pairs
785 Returns a hash of all column keys and associated values. Values for any
786 columns set to use inflation will be inflated and returns as objects.
788 See L</get_columns> to get the uninflated values.
790 See L<DBIx::Class::InflateColumn> for how to setup inflation.
794 sub get_inflated_columns {
797 my %loaded_colinfo = (map
798 { $_ => $self->column_info($_) }
799 (grep { $self->has_column_loaded($_) } $self->columns)
803 for my $col (keys %loaded_colinfo) {
804 if (exists $loaded_colinfo{$col}{accessor}) {
805 my $acc = $loaded_colinfo{$col}{accessor};
806 $inflated{$col} = $self->$acc if defined $acc;
809 $inflated{$col} = $self->$col;
813 # return all loaded columns with the inflations overlayed on top
814 return ($self->get_columns, %inflated);
817 sub _is_column_numeric {
818 my ($self, $column) = @_;
819 my $colinfo = $self->column_info ($column);
821 # cache for speed (the object may *not* have a resultsource instance)
822 if (not defined $colinfo->{is_numeric} && $self->_source_handle) {
823 $colinfo->{is_numeric} =
824 $self->result_source->schema->storage->is_datatype_numeric ($colinfo->{data_type})
830 return $colinfo->{is_numeric};
835 $row->set_column($col => $val);
839 =item Arguments: $columnname, $value
841 =item Returns: $value
845 Sets a raw column value. If the new value is different from the old one,
846 the column is marked as dirty for when you next call L</update>.
848 If passed an object or reference as a value, this method will happily
849 attempt to store it, and a later L</insert> or L</update> will try and
850 stringify/numify as appropriate. To set an object to be deflated
851 instead, see L</set_inflated_columns>.
856 my ($self, $column, $new_value) = @_;
858 # if we can't get an ident condition on first try - mark the object as unidentifiable
859 $self->{_orig_ident} ||= (try { $self->ident_condition }) || {};
861 my $old_value = $self->get_column($column);
862 $new_value = $self->store_column($column, $new_value);
865 $self->{_dirty_columns}{$column}
867 $self->in_storage # no point tracking dirtyness on uninserted data
868 ? ! $self->_eq_column_values ($column, $old_value, $new_value)
872 # FIXME sadly the update code just checks for keys, not for their value
873 $self->{_dirty_columns}{$column} = 1 if $dirty;
875 # XXX clear out the relation cache for this column
876 delete $self->{related_resultsets}{$column};
881 sub _eq_column_values {
882 my ($self, $col, $old, $new) = @_;
884 if (defined $old xor defined $new) {
887 elsif (not defined $old) { # both undef
890 elsif ($old eq $new) {
893 elsif ($self->_is_column_numeric($col)) { # do a numeric comparison if datatype allows it
903 $row->set_columns({ $col => $val, ... });
907 =item Arguments: \%columndata
909 =item Returns: The Row object
913 Sets multiple column, raw value pairs at once.
915 Works as L</set_column>.
920 my ($self,$data) = @_;
921 foreach my $col (keys %$data) {
922 $self->set_column($col,$data->{$col});
927 =head2 set_inflated_columns
929 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
933 =item Arguments: \%columndata
935 =item Returns: The Row object
939 Sets more than one column value at once. Any inflated values are
940 deflated and the raw values stored.
942 Any related values passed as Row objects, using the relation name as a
943 key, are reduced to the appropriate foreign key values and stored. If
944 instead of related row objects, a hashref of column, value data is
945 passed, will create the related object first then store.
947 Will even accept arrayrefs of data as a value to a
948 L<DBIx::Class::Relationship/has_many> key, and create the related
949 objects if necessary.
951 Be aware that the input hashref might be edited in place, so don't rely
952 on it being the same after a call to C<set_inflated_columns>. If you
953 need to preserve the hashref, it is sufficient to pass a shallow copy
954 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
956 See also L<DBIx::Class::Relationship::Base/set_from_related>.
960 sub set_inflated_columns {
961 my ( $self, $upd ) = @_;
962 foreach my $key (keys %$upd) {
963 if (ref $upd->{$key}) {
964 my $info = $self->relationship_info($key);
965 my $acc_type = $info->{attrs}{accessor} || '';
966 if ($acc_type eq 'single') {
967 my $rel = delete $upd->{$key};
968 $self->set_from_related($key => $rel);
969 $self->{_relationship_data}{$key} = $rel;
971 elsif ($acc_type eq 'multi') {
972 $self->throw_exception(
973 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
976 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
977 $self->set_inflated_column($key, delete $upd->{$key});
981 $self->set_columns($upd);
986 my $copy = $orig->copy({ change => $to, ... });
990 =item Arguments: \%replacementdata
992 =item Returns: The Row object copy
996 Inserts a new row into the database, as a copy of the original
997 object. If a hashref of replacement data is supplied, these will take
998 precedence over data in the original. Also any columns which have
999 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
1000 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
1001 so that the database can insert its own autoincremented values into
1004 Relationships will be followed by the copy procedure B<only> if the
1005 relationship specifies a true value for its
1006 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1007 is set by default on C<has_many> relationships and unset on all others.
1012 my ($self, $changes) = @_;
1014 my $col_data = { %{$self->{_column_data}} };
1015 foreach my $col (keys %$col_data) {
1016 delete $col_data->{$col}
1017 if $self->result_source->column_info($col)->{is_auto_increment};
1020 my $new = { _column_data => $col_data };
1021 bless $new, ref $self;
1023 $new->result_source($self->result_source);
1024 $new->set_inflated_columns($changes);
1027 # Its possible we'll have 2 relations to the same Source. We need to make
1028 # sure we don't try to insert the same row twice else we'll violate unique
1030 my $rels_copied = {};
1032 foreach my $rel ($self->result_source->relationships) {
1033 my $rel_info = $self->result_source->relationship_info($rel);
1035 next unless $rel_info->{attrs}{cascade_copy};
1037 my $resolved = $self->result_source->_resolve_condition(
1038 $rel_info->{cond}, $rel, $new
1041 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1042 foreach my $related ($self->search_related($rel)) {
1043 my $id_str = join("\0", $related->id);
1044 next if $copied->{$id_str};
1045 $copied->{$id_str} = 1;
1046 my $rel_copy = $related->copy($resolved);
1055 $row->store_column($col => $val);
1059 =item Arguments: $columnname, $value
1061 =item Returns: The value sent to storage
1065 Set a raw value for a column without marking it as changed. This
1066 method is used internally by L</set_column> which you should probably
1069 This is the lowest level at which data is set on a row object,
1070 extend this method to catch all data setting methods.
1075 my ($self, $column, $value) = @_;
1076 $self->throw_exception( "No such column '${column}'" )
1077 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1078 $self->throw_exception( "set_column called for ${column} without value" )
1080 return $self->{_column_data}{$column} = $value;
1083 =head2 inflate_result
1085 Class->inflate_result($result_source, \%me, \%prefetch?)
1089 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1091 =item Returns: A Row object
1095 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1096 database and turn it into row objects call this method.
1098 Extend this method in your Result classes to hook into this process,
1099 for example to rebless the result into a different class.
1101 Reblessing can also be done more easily by setting C<result_class> in
1102 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1104 Different types of results can also be created from a particular
1105 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1109 sub inflate_result {
1110 my ($class, $source, $me, $prefetch) = @_;
1112 my ($source_handle) = $source;
1114 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
1115 $source = $source_handle->resolve
1118 $source_handle = $source->handle
1122 _source_handle => $source_handle,
1123 _column_data => $me,
1125 bless $new, (ref $class || $class);
1127 foreach my $pre (keys %{$prefetch||{}}) {
1129 my $pre_source = $source->related_source($pre)
1130 or $class->throw_exception("Can't prefetch non-existent relationship ${pre}");
1132 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1133 or $class->throw_exception("No accessor for prefetched $pre");
1136 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1137 @pre_vals = @{$prefetch->{$pre}};
1139 elsif ($accessor eq 'multi') {
1140 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor 'multi'");
1143 @pre_vals = $prefetch->{$pre};
1147 for my $me_pref (@pre_vals) {
1149 # FIXME - this should not be necessary
1150 # the collapser currently *could* return bogus elements with all
1151 # columns set to undef
1153 for (values %{$me_pref->[0]}) {
1159 next unless $has_def;
1161 push @pre_objects, $pre_source->result_class->inflate_result(
1162 $pre_source, @$me_pref
1166 if ($accessor eq 'single') {
1167 $new->{_relationship_data}{$pre} = $pre_objects[0];
1169 elsif ($accessor eq 'filter') {
1170 $new->{_inflated_column}{$pre} = $pre_objects[0];
1173 $new->related_resultset($pre)->set_cache(\@pre_objects);
1176 $new->in_storage (1);
1180 =head2 update_or_insert
1182 $row->update_or_insert
1186 =item Arguments: none
1188 =item Returns: Result of update or insert operation
1192 L</Update>s the object if it's already in the database, according to
1193 L</in_storage>, else L</insert>s it.
1195 =head2 insert_or_update
1197 $obj->insert_or_update
1199 Alias for L</update_or_insert>
1203 sub insert_or_update { shift->update_or_insert(@_) }
1205 sub update_or_insert {
1207 return ($self->in_storage ? $self->update : $self->insert);
1212 my @changed_col_names = $row->is_changed();
1213 if ($row->is_changed()) { ... }
1217 =item Arguments: none
1219 =item Returns: 0|1 or @columnnames
1223 In list context returns a list of columns with uncommited changes, or
1224 in scalar context returns a true value if there are uncommitted
1230 return keys %{shift->{_dirty_columns} || {}};
1233 =head2 is_column_changed
1235 if ($row->is_column_changed('col')) { ... }
1239 =item Arguments: $columname
1245 Returns a true value if the column has uncommitted changes.
1249 sub is_column_changed {
1250 my( $self, $col ) = @_;
1251 return exists $self->{_dirty_columns}->{$col};
1254 =head2 result_source
1256 my $resultsource = $row->result_source;
1260 =item Arguments: none
1262 =item Returns: a ResultSource instance
1266 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1274 $self->_source_handle($_[0]->handle);
1276 $self->_source_handle->resolve;
1280 =head2 register_column
1282 $column_info = { .... };
1283 $class->register_column($column_name, $column_info);
1287 =item Arguments: $columnname, \%columninfo
1289 =item Returns: undefined
1293 Registers a column on the class. If the column_info has an 'accessor'
1294 key, creates an accessor named after the value if defined; if there is
1295 no such key, creates an accessor with the same name as the column
1297 The column_info attributes are described in
1298 L<DBIx::Class::ResultSource/add_columns>
1302 sub register_column {
1303 my ($class, $col, $info) = @_;
1305 if (exists $info->{accessor}) {
1306 return unless defined $info->{accessor};
1307 $acc = [ $info->{accessor}, $col ];
1309 $class->mk_group_accessors('column' => $acc);
1312 =head2 get_from_storage
1314 my $copy = $row->get_from_storage($attrs)
1318 =item Arguments: \%attrs
1320 =item Returns: A Row object
1324 Fetches a fresh copy of the Row object from the database and returns it.
1325 Throws an exception if a proper WHERE clause identifying the database row
1326 can not be constructed (i.e. if the original object does not contain its
1328 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1329 ). If passed the \%attrs argument, will first apply these attributes to
1330 the resultset used to find the row.
1332 This copy can then be used to compare to an existing row object, to
1333 determine if any changes have been made in the database since it was
1336 To just update your Row object with any latest changes from the
1337 database, use L</discard_changes> instead.
1339 The \%attrs argument should be compatible with
1340 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1344 sub get_from_storage {
1345 my $self = shift @_;
1346 my $attrs = shift @_;
1347 my $resultset = $self->result_source->resultset;
1349 if(defined $attrs) {
1350 $resultset = $resultset->search(undef, $attrs);
1353 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
1355 $self->throw_exception('Unable to requery a row with incomplete or no identity')
1356 if ! keys %$ident_cond;
1358 return $resultset->find($ident_cond);
1361 =head2 discard_changes ($attrs)
1363 Re-selects the row from the database, losing any changes that had
1364 been made. Throws an exception if a proper WHERE clause identifying
1365 the database row can not be constructed (i.e. if the original object
1366 does not contain its entire
1367 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1370 This method can also be used to refresh from storage, retrieving any
1371 changes made since the row was last read from storage.
1373 $attrs is expected to be a hashref of attributes suitable for passing as the
1374 second argument to $resultset->search($cond, $attrs);
1378 sub discard_changes {
1379 my ($self, $attrs) = @_;
1380 return unless $self->in_storage; # Don't reload if we aren't real!
1382 # add a replication default to read from the master only
1383 $attrs = { force_pool => 'master', %{$attrs||{}} };
1385 if( my $current_storage = $self->get_from_storage($attrs)) {
1387 # Set $self to the current.
1388 %$self = %$current_storage;
1390 # Avoid a possible infinite loop with
1391 # sub DESTROY { $_[0]->discard_changes }
1392 bless $current_storage, 'Do::Not::Exist';
1397 $self->in_storage(0);
1403 =head2 throw_exception
1405 See L<DBIx::Class::Schema/throw_exception>.
1409 sub throw_exception {
1412 if (ref $self && ref $self->result_source && $self->result_source->schema) {
1413 $self->result_source->schema->throw_exception(@_)
1416 DBIx::Class::Exception->throw(@_);
1426 =item Arguments: none
1428 =item Returns: A list of primary key values
1432 Returns the primary key(s) for a row. Can't be called as a class method.
1433 Actually implemented in L<DBIx::Class::PK>
1435 =head2 discard_changes
1437 $row->discard_changes
1441 =item Arguments: none
1443 =item Returns: nothing (updates object in-place)
1447 Retrieves and sets the row object data from the database, losing any
1450 This method can also be used to refresh from storage, retrieving any
1451 changes made since the row was last read from storage. Actually
1452 implemented in L<DBIx::Class::PK>
1454 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1455 storage, please kept in mind that if you L</discard_changes> on a row that you
1456 just updated or created, you should wrap the entire bit inside a transaction.
1457 Otherwise you run the risk that you insert or update to the master database
1458 but read from a replicant database that has not yet been updated from the
1459 master. This will result in unexpected results.
1467 Matt S. Trout <mst@shadowcatsystems.co.uk>
1471 You may distribute this code under the same terms as Perl itself.