1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
8 use DBIx::Class::Exception;
9 use Scalar::Util 'blessed';
18 $ENV{DBIC_MULTICREATE_DEBUG}
27 DBIx::Class::Row - Basic row methods
33 This class is responsible for defining and doing basic operations on rows
34 derived from L<DBIx::Class::ResultSource> objects.
36 Row objects are returned from L<DBIx::Class::ResultSet>s using the
37 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
38 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
39 as well as invocations of 'single' (
40 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
41 L<has_one|DBIx::Class::Relationship/has_one> or
42 L<might_have|DBIx::Class::Relationship/might_have>)
43 relationship accessors of L<DBIx::Class::Row> objects.
49 my $row = My::Class->new(\%attrs);
51 my $row = $schema->resultset('MySource')->new(\%colsandvalues);
55 =item Arguments: \%attrs or \%colsandvalues
57 =item Returns: A Row object
61 While you can create a new row object by calling C<new> directly on
62 this class, you are better off calling it on a
63 L<DBIx::Class::ResultSet> object.
65 When calling it directly, you will not get a complete, usable row
66 object until you pass or set the C<result_source> attribute, to a
67 L<DBIx::Class::ResultSource> instance that is attached to a
68 L<DBIx::Class::Schema> with a valid connection.
70 C<$attrs> is a hashref of column name, value data. It can also contain
71 some other attributes such as the C<result_source>.
73 Passing an object, or an arrayref of objects as a value will call
74 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
75 passed a hashref or an arrayref of hashrefs as the value, these will
76 be turned into objects via new_related, and treated as if you had
79 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
81 Please note that if a value is not passed to new, no value will be sent
82 in the SQL INSERT call, and the column will therefore assume whatever
83 default value was specified in your database. While DBIC will retrieve the
84 value of autoincrement columns, it will never make an explicit database
85 trip to retrieve default values assigned by the RDBMS. You can explicitly
86 request that all values be fetched back from the database by calling
87 L</discard_changes>, or you can supply an explicit C<undef> to columns
88 with NULL as the default, and save yourself a SELECT.
92 The behavior described above will backfire if you use a foreign key column
93 with a database-defined default. If you call the relationship accessor on
94 an object that doesn't have a set value for the FK column, DBIC will throw
95 an exception, as it has no way of knowing the PK of the related object (if
100 ## 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().
101 ## This only works because DBIC doesnt yet care to check whether the new_related objects have been passed all their mandatory columns
102 ## When doing the later insert, we need to make sure the PKs are set.
103 ## using _relationship_data in new and funky ways..
104 ## check Relationship::CascadeActions and Relationship::Accessor for compat
107 sub __new_related_find_or_new_helper {
108 my ($self, $relname, $data) = @_;
110 my $rsrc = $self->result_source;
112 # create a mock-object so all new/set_column component overrides will run:
113 my $rel_rs = $rsrc->related_source($relname)->resultset;
114 my $new_rel_obj = $rel_rs->new_result($data);
115 my $proc_data = { $new_rel_obj->get_columns };
117 if ($self->__their_pk_needs_us($relname)) {
118 MULTICREATE_DEBUG and warn "MC $self constructing $relname via new_result";
121 elsif ($rsrc->_pk_depends_on($relname, $proc_data )) {
122 if (! keys %$proc_data) {
123 # there is nothing to search for - blind create
124 MULTICREATE_DEBUG and warn "MC $self constructing default-insert $relname";
127 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new";
128 # this is not *really* find or new, as we don't want to double-new the
129 # data (thus potentially double encoding or whatever)
130 my $exists = $rel_rs->find ($proc_data);
131 return $exists if $exists;
136 my $us = $rsrc->source_name;
137 $self->throw_exception (
138 "Unable to determine relationship '$relname' direction from '$us', "
139 . "possibly due to a missing reverse-relationship on '$relname' to '$us'."
144 sub __their_pk_needs_us { # this should maybe be in resultsource.
145 my ($self, $relname) = @_;
146 my $source = $self->result_source;
147 my $reverse = $source->reverse_relationship_info($relname);
148 my $rel_source = $source->related_source($relname);
149 my $us = { $self->get_columns };
150 foreach my $key (keys %$reverse) {
151 # if their primary key depends on us, then we have to
152 # just create a result and we'll fill it out afterwards
153 return 1 if $rel_source->_pk_depends_on($key, $us);
159 my ($class, $attrs) = @_;
160 $class = ref $class if ref $class;
162 my $new = bless { _column_data => {} }, $class;
165 $new->throw_exception("attrs must be a hashref")
166 unless ref($attrs) eq 'HASH';
168 my $source = delete $attrs->{-result_source};
169 if ( my $h = delete $attrs->{-source_handle} ) {
170 $source ||= $h->resolve;
173 $new->result_source($source) if $source;
175 if (my $col_from_rel = delete $attrs->{-cols_from_relations}) {
176 @{$new->{_ignore_at_insert}={}}{@$col_from_rel} = ();
179 my ($related,$inflated);
181 foreach my $key (keys %$attrs) {
182 if (ref $attrs->{$key}) {
183 ## Can we extract this lot to use with update(_or .. ) ?
184 $new->throw_exception("Can't do multi-create without result source")
186 my $info = $source->relationship_info($key);
187 my $acc_type = $info->{attrs}{accessor} || '';
188 if ($acc_type eq 'single') {
189 my $rel_obj = delete $attrs->{$key};
190 if(!blessed $rel_obj) {
191 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
194 if ($rel_obj->in_storage) {
195 $new->{_rel_in_storage}{$key} = 1;
196 $new->set_from_related($key, $rel_obj);
198 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj\n";
201 $related->{$key} = $rel_obj;
204 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
205 my $others = delete $attrs->{$key};
206 my $total = @$others;
208 foreach my $idx (0 .. $#$others) {
209 my $rel_obj = $others->[$idx];
210 if(!blessed $rel_obj) {
211 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
214 if ($rel_obj->in_storage) {
215 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
217 MULTICREATE_DEBUG and
218 warn "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
220 push(@objects, $rel_obj);
222 $related->{$key} = \@objects;
225 elsif ($acc_type eq 'filter') {
226 ## 'filter' should disappear and get merged in with 'single' above!
227 my $rel_obj = delete $attrs->{$key};
228 if(!blessed $rel_obj) {
229 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
231 if ($rel_obj->in_storage) {
232 $new->{_rel_in_storage}{$key} = 1;
235 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj";
237 $inflated->{$key} = $rel_obj;
239 } elsif ($class->has_column($key)
240 && $class->column_info($key)->{_inflate_info}) {
241 $inflated->{$key} = $attrs->{$key};
245 $new->throw_exception("No such column $key on $class")
246 unless $class->has_column($key);
247 $new->store_column($key => $attrs->{$key});
250 $new->{_relationship_data} = $related if $related;
251 $new->{_inflated_column} = $inflated if $inflated;
263 =item Arguments: none
265 =item Returns: The Row object
269 Inserts an object previously created by L</new> into the database if
270 it isn't already in there. Returns the object itself. To insert an
271 entirely new row into the database, use L<DBIx::Class::ResultSet/create>.
273 To fetch an uninserted row object, call
274 L<new|DBIx::Class::ResultSet/new> on a resultset.
276 This will also insert any uninserted, related objects held inside this
277 one, see L<DBIx::Class::ResultSet/create> for more details.
283 return $self if $self->in_storage;
284 my $source = $self->result_source;
285 $self->throw_exception("No result_source set on this object; can't insert")
288 my $storage = $source->storage;
292 # Check if we stored uninserted relobjs here in new()
293 my %related_stuff = (%{$self->{_relationship_data} || {}},
294 %{$self->{_inflated_column} || {}});
296 # insert what needs to be inserted before us
298 for my $relname (keys %related_stuff) {
299 my $rel_obj = $related_stuff{$relname};
301 if (! $self->{_rel_in_storage}{$relname}) {
302 next unless (blessed $rel_obj && $rel_obj->isa('DBIx::Class::Row'));
304 next unless $source->_pk_depends_on(
305 $relname, { $rel_obj->get_columns }
308 # The guard will save us if we blow out of this scope via die
309 $rollback_guard ||= $storage->txn_scope_guard;
311 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
313 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_columns };
316 # if there are no keys - nothing to search for
317 if (keys %$them and $existing = $self->result_source
318 ->related_source($relname)
322 %{$rel_obj} = %{$existing};
328 $self->{_rel_in_storage}{$relname} = 1;
331 $self->set_from_related($relname, $rel_obj);
332 delete $related_stuff{$relname};
335 # start a transaction here if not started yet and there is more stuff
337 if (keys %related_stuff) {
338 $rollback_guard ||= $storage->txn_scope_guard
341 MULTICREATE_DEBUG and do {
342 no warnings 'uninitialized';
343 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
346 my %current_rowdata = $self->get_columns;
348 # perform the insert - the storage may return some stuff for us right there
350 my $returned_cols = $storage->insert(
355 for (keys %$returned_cols) {
358 ( $current_rowdata{$_} = $returned_cols->{$_} )
362 # see if any of the pcols still need filling (or re-querying in case of scalarrefs)
363 my @missing_pri = grep
364 { ! defined $current_rowdata{$_} or ref $current_rowdata{$_} eq 'SCALAR' }
365 $self->primary_columns
369 MULTICREATE_DEBUG and warn "MC $self fetching missing PKs ".join(', ', @missing_pri )."\n";
371 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
372 unless $storage->can('last_insert_id');
374 my @pri_values = $storage->last_insert_id($self->result_source, @missing_pri);
376 $self->throw_exception( "Can't get last insert id" )
377 unless (@pri_values == @missing_pri);
379 $self->store_column($missing_pri[$_] => $pri_values[$_]) for 0 .. $#missing_pri;
382 $self->{_dirty_columns} = {};
383 $self->{related_resultsets} = {};
385 foreach my $relname (keys %related_stuff) {
386 next unless $source->has_relationship ($relname);
388 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
389 ? @{$related_stuff{$relname}}
390 : $related_stuff{$relname}
393 if (@cands && blessed $cands[0] && $cands[0]->isa('DBIx::Class::Row')
395 my $reverse = $source->reverse_relationship_info($relname);
396 foreach my $obj (@cands) {
397 $obj->set_from_related($_, $self) for keys %$reverse;
398 if ($self->__their_pk_needs_us($relname)) {
399 if (exists $self->{_ignore_at_insert}{$relname}) {
400 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
403 MULTICREATE_DEBUG and warn "MC $self inserting $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->{_orig_ident_failreason};
417 delete $self->{_ignore_at_insert};
418 $rollback_guard->commit if $rollback_guard;
425 $row->in_storage; # Get value
426 $row->in_storage(1); # Set value
430 =item Arguments: none or 1|0
436 Indicates whether the object exists as a row in the database or
437 not. This is set to true when L<DBIx::Class::ResultSet/find>,
438 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
441 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
442 L</delete> on one, sets it to false.
447 my ($self, $val) = @_;
448 $self->{_in_storage} = $val if @_ > 1;
449 return $self->{_in_storage} ? 1 : 0;
454 $row->update(\%columns?)
458 =item Arguments: none or a hashref
460 =item Returns: The Row object
464 Throws an exception if the row object is not yet in the database,
465 according to L</in_storage>.
467 This method issues an SQL UPDATE query to commit any changes to the
468 object to the database if required (see L</get_dirty_columns>).
469 It throws an exception if a proper WHERE clause uniquely identifying
470 the database row can not be constructed (see
471 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
474 Also takes an optional hashref of C<< column_name => value >> pairs
475 to update on the object first. Be aware that the hashref will be
476 passed to C<set_inflated_columns>, which might edit it in place, so
477 don't rely on it being the same after a call to C<update>. If you
478 need to preserve the hashref, it is sufficient to pass a shallow copy
479 to C<update>, e.g. ( { %{ $href } } )
481 If the values passed or any of the column values set on the object
482 contain scalar references, e.g.:
484 $row->last_modified(\'NOW()');
486 $row->update({ last_modified => \'NOW()' });
488 The update will pass the values verbatim into SQL. (See
489 L<SQL::Abstract> docs). The values in your Row object will NOT change
490 as a result of the update call, if you want the object to be updated
491 with the actual values from the database, call L</discard_changes>
494 $row->update()->discard_changes();
496 To determine before calling this method, which column values have
497 changed and will be updated, call L</get_dirty_columns>.
499 To check if any columns will be updated, call L</is_changed>.
501 To force a column to be updated, call L</make_column_dirty> before
507 my ($self, $upd) = @_;
509 $self->set_inflated_columns($upd) if $upd;
511 my %to_update = $self->get_dirty_columns
514 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
515 $self->throw_exception( "Not in database" ) unless $self->in_storage;
517 $self->throw_exception($self->{_orig_ident_failreason})
518 if ! keys %$ident_cond;
520 my $rows = $self->result_source->storage->update(
521 $self->result_source, \%to_update, $ident_cond
524 $self->throw_exception( "Can't update ${self}: row not found" );
525 } elsif ($rows > 1) {
526 $self->throw_exception("Can't update ${self}: updated more than one row");
528 $self->{_dirty_columns} = {};
529 $self->{related_resultsets} = {};
530 delete $self->{_orig_ident};
540 =item Arguments: none
542 =item Returns: The Row object
546 Throws an exception if the object is not in the database according to
547 L</in_storage>. Also throws an exception if a proper WHERE clause
548 uniquely identifying the database row can not be constructed (see
549 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
552 The object is still perfectly usable, but L</in_storage> will
553 now return 0 and the object must be reinserted using L</insert>
554 before it can be used to L</update> the row again.
556 If you delete an object in a class with a C<has_many> relationship, an
557 attempt is made to delete all the related objects as well. To turn
558 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
559 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
560 database-level cascade or restrict will take precedence over a
561 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
562 main row first> and only then attempts to delete any remaining related
565 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
566 and the transaction subsequently fails, the row object will remain marked as
567 not being in storage. If you know for a fact that the object is still in
568 storage (i.e. by inspecting the cause of the transaction's failure), you can
569 use C<< $obj->in_storage(1) >> to restore consistency between the object and
570 the database. This would allow a subsequent C<< $obj->delete >> to work
573 See also L<DBIx::Class::ResultSet/delete>.
580 $self->throw_exception( "Not in database" ) unless $self->in_storage;
582 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
583 $self->throw_exception($self->{_orig_ident_failreason})
584 if ! keys %$ident_cond;
586 $self->result_source->storage->delete(
587 $self->result_source, $ident_cond
590 delete $self->{_orig_ident}; # no longer identifiable
591 $self->in_storage(undef);
594 my $rsrc = try { $self->result_source_instance }
595 or $self->throw_exception("Can't do class delete without a ResultSource instance");
597 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
598 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
599 $rsrc->resultset->search(@_)->delete;
606 my $val = $row->get_column($col);
610 =item Arguments: $columnname
612 =item Returns: The value of the column
616 Throws an exception if the column name given doesn't exist according
619 Returns a raw column value from the row object, if it has already
620 been fetched from the database or set by an accessor.
622 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
623 will be deflated and returned.
625 Note that if you used the C<columns> or the C<select/as>
626 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
627 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
628 this method will return C<undef> even if the database contains some value.
630 To retrieve all loaded column values as a hash, use L</get_columns>.
635 my ($self, $column) = @_;
636 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
637 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
638 if (exists $self->{_inflated_column}{$column}) {
639 return $self->store_column($column,
640 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
642 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
646 =head2 has_column_loaded
648 if ( $row->has_column_loaded($col) ) {
649 print "$col has been loaded from db";
654 =item Arguments: $columnname
660 Returns a true value if the column value has been loaded from the
661 database (or set locally).
665 sub has_column_loaded {
666 my ($self, $column) = @_;
667 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
668 return 1 if exists $self->{_inflated_column}{$column};
669 return exists $self->{_column_data}{$column};
674 my %data = $row->get_columns;
678 =item Arguments: none
680 =item Returns: A hash of columnname, value pairs.
684 Returns all loaded column data as a hash, containing raw values. To
685 get just one value for a particular column, use L</get_column>.
687 See L</get_inflated_columns> to get the inflated values.
693 if (exists $self->{_inflated_column}) {
694 foreach my $col (keys %{$self->{_inflated_column}}) {
695 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
696 unless exists $self->{_column_data}{$col};
699 return %{$self->{_column_data}};
702 =head2 get_dirty_columns
704 my %data = $row->get_dirty_columns;
708 =item Arguments: none
710 =item Returns: A hash of column, value pairs
714 Only returns the column, value pairs for those columns that have been
715 changed on this object since the last L</update> or L</insert> call.
717 See L</get_columns> to fetch all column/value pairs.
721 sub get_dirty_columns {
723 return map { $_ => $self->{_column_data}{$_} }
724 keys %{$self->{_dirty_columns}};
727 =head2 make_column_dirty
729 $row->make_column_dirty($col)
733 =item Arguments: $columnname
735 =item Returns: undefined
739 Throws an exception if the column does not exist.
741 Marks a column as having been changed regardless of whether it has
745 sub make_column_dirty {
746 my ($self, $column) = @_;
748 $self->throw_exception( "No such column '${column}'" )
749 unless exists $self->{_column_data}{$column} || $self->has_column($column);
751 # the entire clean/dirty code relies on exists, not on true/false
752 return 1 if exists $self->{_dirty_columns}{$column};
754 $self->{_dirty_columns}{$column} = 1;
756 # if we are just now making the column dirty, and if there is an inflated
757 # value, force it over the deflated one
758 if (exists $self->{_inflated_column}{$column}) {
759 $self->store_column($column,
760 $self->_deflated_column(
761 $column, $self->{_inflated_column}{$column}
767 =head2 get_inflated_columns
769 my %inflated_data = $obj->get_inflated_columns;
773 =item Arguments: none
775 =item Returns: A hash of column, object|value pairs
779 Returns a hash of all column keys and associated values. Values for any
780 columns set to use inflation will be inflated and returns as objects.
782 See L</get_columns> to get the uninflated values.
784 See L<DBIx::Class::InflateColumn> for how to setup inflation.
788 sub get_inflated_columns {
791 my $loaded_colinfo = $self->columns_info ([
792 grep { $self->has_column_loaded($_) } $self->columns
796 for my $col (keys %$loaded_colinfo) {
797 if (exists $loaded_colinfo->{$col}{accessor}) {
798 my $acc = $loaded_colinfo->{$col}{accessor};
799 $inflated{$col} = $self->$acc if defined $acc;
802 $inflated{$col} = $self->$col;
806 # return all loaded columns with the inflations overlayed on top
807 return %{ { $self->get_columns, %inflated } };
810 sub _is_column_numeric {
811 my ($self, $column) = @_;
812 my $colinfo = $self->column_info ($column);
814 # cache for speed (the object may *not* have a resultsource instance)
816 ! defined $colinfo->{is_numeric}
818 my $storage = try { $self->result_source->schema->storage }
820 $colinfo->{is_numeric} =
821 $storage->is_datatype_numeric ($colinfo->{data_type})
827 return $colinfo->{is_numeric};
832 $row->set_column($col => $val);
836 =item Arguments: $columnname, $value
838 =item Returns: $value
842 Sets a raw column value. If the new value is different from the old one,
843 the column is marked as dirty for when you next call L</update>.
845 If passed an object or reference as a value, this method will happily
846 attempt to store it, and a later L</insert> or L</update> will try and
847 stringify/numify as appropriate. To set an object to be deflated
848 instead, see L</set_inflated_columns>.
853 my ($self, $column, $new_value) = @_;
855 # if we can't get an ident condition on first try - mark the object as unidentifiable
856 # (by using an empty hashref) and store the error for further diag
857 unless ($self->{_orig_ident}) {
859 $self->{_orig_ident} = $self->ident_condition
862 $self->{_orig_ident_failreason} = $_;
863 $self->{_orig_ident} = {};
867 my $old_value = $self->get_column($column);
868 $new_value = $self->store_column($column, $new_value);
871 $self->{_dirty_columns}{$column}
873 $self->in_storage # no point tracking dirtyness on uninserted data
874 ? ! $self->_eq_column_values ($column, $old_value, $new_value)
879 # FIXME sadly the update code just checks for keys, not for their value
880 $self->{_dirty_columns}{$column} = 1;
882 # Clear out the relation/inflation cache related to this column
884 # FIXME - this is a quick *largely incorrect* hack, pending a more
885 # serious rework during the merge of single and filter rels
886 my $rels = $self->result_source->{_relationships};
887 for my $rel (keys %$rels) {
889 my $acc = $rels->{$rel}{attrs}{accessor} || '';
891 if ( $acc eq 'single' and $rels->{$rel}{attrs}{fk_columns}{$column} ) {
892 delete $self->{related_resultsets}{$rel};
893 delete $self->{_relationship_data}{$rel};
894 #delete $self->{_inflated_column}{$rel};
896 elsif ( $acc eq 'filter' and $rel eq $column) {
897 delete $self->{related_resultsets}{$rel};
898 #delete $self->{_relationship_data}{$rel};
899 delete $self->{_inflated_column}{$rel};
907 sub _eq_column_values {
908 my ($self, $col, $old, $new) = @_;
910 if (defined $old xor defined $new) {
913 elsif (not defined $old) { # both undef
916 elsif ($old eq $new) {
919 elsif ($self->_is_column_numeric($col)) { # do a numeric comparison if datatype allows it
929 $row->set_columns({ $col => $val, ... });
933 =item Arguments: \%columndata
935 =item Returns: The Row object
939 Sets multiple column, raw value pairs at once.
941 Works as L</set_column>.
946 my ($self,$data) = @_;
947 foreach my $col (keys %$data) {
948 $self->set_column($col,$data->{$col});
953 =head2 set_inflated_columns
955 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
959 =item Arguments: \%columndata
961 =item Returns: The Row object
965 Sets more than one column value at once. Any inflated values are
966 deflated and the raw values stored.
968 Any related values passed as Row objects, using the relation name as a
969 key, are reduced to the appropriate foreign key values and stored. If
970 instead of related row objects, a hashref of column, value data is
971 passed, will create the related object first then store.
973 Will even accept arrayrefs of data as a value to a
974 L<DBIx::Class::Relationship/has_many> key, and create the related
975 objects if necessary.
977 Be aware that the input hashref might be edited in place, so don't rely
978 on it being the same after a call to C<set_inflated_columns>. If you
979 need to preserve the hashref, it is sufficient to pass a shallow copy
980 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
982 See also L<DBIx::Class::Relationship::Base/set_from_related>.
986 sub set_inflated_columns {
987 my ( $self, $upd ) = @_;
988 foreach my $key (keys %$upd) {
989 if (ref $upd->{$key}) {
990 my $info = $self->relationship_info($key);
991 my $acc_type = $info->{attrs}{accessor} || '';
992 if ($acc_type eq 'single') {
993 my $rel = delete $upd->{$key};
994 $self->set_from_related($key => $rel);
995 $self->{_relationship_data}{$key} = $rel;
997 elsif ($acc_type eq 'multi') {
998 $self->throw_exception(
999 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
1002 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
1003 $self->set_inflated_column($key, delete $upd->{$key});
1007 $self->set_columns($upd);
1012 my $copy = $orig->copy({ change => $to, ... });
1016 =item Arguments: \%replacementdata
1018 =item Returns: The Row object copy
1022 Inserts a new row into the database, as a copy of the original
1023 object. If a hashref of replacement data is supplied, these will take
1024 precedence over data in the original. Also any columns which have
1025 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
1026 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
1027 so that the database can insert its own autoincremented values into
1030 Relationships will be followed by the copy procedure B<only> if the
1031 relationship specifies a true value for its
1032 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1033 is set by default on C<has_many> relationships and unset on all others.
1038 my ($self, $changes) = @_;
1040 my $col_data = { %{$self->{_column_data}} };
1042 my $colinfo = $self->columns_info([ keys %$col_data ]);
1043 foreach my $col (keys %$col_data) {
1044 delete $col_data->{$col}
1045 if $colinfo->{$col}{is_auto_increment};
1048 my $new = { _column_data => $col_data };
1049 bless $new, ref $self;
1051 $new->result_source($self->result_source);
1052 $new->set_inflated_columns($changes);
1055 # Its possible we'll have 2 relations to the same Source. We need to make
1056 # sure we don't try to insert the same row twice else we'll violate unique
1058 my $rels_copied = {};
1060 foreach my $rel ($self->result_source->relationships) {
1061 my $rel_info = $self->result_source->relationship_info($rel);
1063 next unless $rel_info->{attrs}{cascade_copy};
1065 my $resolved = $self->result_source->_resolve_condition(
1066 $rel_info->{cond}, $rel, $new, $rel
1069 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1070 foreach my $related ($self->search_related($rel)) {
1071 my $id_str = join("\0", $related->id);
1072 next if $copied->{$id_str};
1073 $copied->{$id_str} = 1;
1074 my $rel_copy = $related->copy($resolved);
1083 $row->store_column($col => $val);
1087 =item Arguments: $columnname, $value
1089 =item Returns: The value sent to storage
1093 Set a raw value for a column without marking it as changed. This
1094 method is used internally by L</set_column> which you should probably
1097 This is the lowest level at which data is set on a row object,
1098 extend this method to catch all data setting methods.
1103 my ($self, $column, $value) = @_;
1104 $self->throw_exception( "No such column '${column}'" )
1105 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1106 $self->throw_exception( "set_column called for ${column} without value" )
1108 return $self->{_column_data}{$column} = $value;
1111 =head2 inflate_result
1113 Class->inflate_result($result_source, \%me, \%prefetch?)
1117 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1119 =item Returns: A Row object
1123 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1124 database and turn it into row objects call this method.
1126 Extend this method in your Result classes to hook into this process,
1127 for example to rebless the result into a different class.
1129 Reblessing can also be done more easily by setting C<result_class> in
1130 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1132 Different types of results can also be created from a particular
1133 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1137 sub inflate_result {
1138 my ($class, $source, $me, $prefetch) = @_;
1140 $source = $source->resolve
1141 if $source->isa('DBIx::Class::ResultSourceHandle');
1144 { _column_data => $me, _result_source => $source },
1145 ref $class || $class
1148 foreach my $pre (keys %{$prefetch||{}}) {
1150 my $pre_source = $source->related_source($pre)
1151 or $class->throw_exception("Can't prefetch non-existent relationship ${pre}");
1153 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1154 or $class->throw_exception("No accessor for prefetched $pre");
1157 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1158 @pre_vals = @{$prefetch->{$pre}};
1160 elsif ($accessor eq 'multi') {
1161 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor 'multi'");
1164 @pre_vals = $prefetch->{$pre};
1168 for my $me_pref (@pre_vals) {
1170 # FIXME - this should not be necessary
1171 # the collapser currently *could* return bogus elements with all
1172 # columns set to undef
1174 for (values %{$me_pref->[0]}) {
1180 next unless $has_def;
1182 push @pre_objects, $pre_source->result_class->inflate_result(
1183 $pre_source, @$me_pref
1187 if ($accessor eq 'single') {
1188 $new->{_relationship_data}{$pre} = $pre_objects[0];
1190 elsif ($accessor eq 'filter') {
1191 $new->{_inflated_column}{$pre} = $pre_objects[0];
1194 $new->related_resultset($pre)->set_cache(\@pre_objects);
1197 $new->in_storage (1);
1201 =head2 update_or_insert
1203 $row->update_or_insert
1207 =item Arguments: none
1209 =item Returns: Result of update or insert operation
1213 L</Update>s the object if it's already in the database, according to
1214 L</in_storage>, else L</insert>s it.
1216 =head2 insert_or_update
1218 $obj->insert_or_update
1220 Alias for L</update_or_insert>
1224 sub insert_or_update { shift->update_or_insert(@_) }
1226 sub update_or_insert {
1228 return ($self->in_storage ? $self->update : $self->insert);
1233 my @changed_col_names = $row->is_changed();
1234 if ($row->is_changed()) { ... }
1238 =item Arguments: none
1240 =item Returns: 0|1 or @columnnames
1244 In list context returns a list of columns with uncommited changes, or
1245 in scalar context returns a true value if there are uncommitted
1251 return keys %{shift->{_dirty_columns} || {}};
1254 =head2 is_column_changed
1256 if ($row->is_column_changed('col')) { ... }
1260 =item Arguments: $columname
1266 Returns a true value if the column has uncommitted changes.
1270 sub is_column_changed {
1271 my( $self, $col ) = @_;
1272 return exists $self->{_dirty_columns}->{$col};
1275 =head2 result_source
1277 my $resultsource = $row->result_source;
1281 =item Arguments: $result_source_instance
1283 =item Returns: a ResultSource instance
1287 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1292 $_[0]->throw_exception( 'result_source can be called on instances only' )
1296 ? $_[0]->{_result_source} = $_[1]
1298 # note this is a || not a ||=, the difference is important
1299 : $_[0]->{_result_source} || do {
1300 my $class = ref $_[0];
1301 $_[0]->can('result_source_instance')
1302 ? $_[0]->result_source_instance
1303 : $_[0]->throw_exception(
1304 "No result source instance registered for $class, did you forget to call $class->table(...) ?"
1310 =head2 register_column
1312 $column_info = { .... };
1313 $class->register_column($column_name, $column_info);
1317 =item Arguments: $columnname, \%columninfo
1319 =item Returns: undefined
1323 Registers a column on the class. If the column_info has an 'accessor'
1324 key, creates an accessor named after the value if defined; if there is
1325 no such key, creates an accessor with the same name as the column
1327 The column_info attributes are described in
1328 L<DBIx::Class::ResultSource/add_columns>
1332 sub register_column {
1333 my ($class, $col, $info) = @_;
1335 if (exists $info->{accessor}) {
1336 return unless defined $info->{accessor};
1337 $acc = [ $info->{accessor}, $col ];
1339 $class->mk_group_accessors('column' => $acc);
1342 =head2 get_from_storage
1344 my $copy = $row->get_from_storage($attrs)
1348 =item Arguments: \%attrs
1350 =item Returns: A Row object
1354 Fetches a fresh copy of the Row object from the database and returns it.
1355 Throws an exception if a proper WHERE clause identifying the database row
1356 can not be constructed (i.e. if the original object does not contain its
1358 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1359 ). If passed the \%attrs argument, will first apply these attributes to
1360 the resultset used to find the row.
1362 This copy can then be used to compare to an existing row object, to
1363 determine if any changes have been made in the database since it was
1366 To just update your Row object with any latest changes from the
1367 database, use L</discard_changes> instead.
1369 The \%attrs argument should be compatible with
1370 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1374 sub get_from_storage {
1375 my $self = shift @_;
1376 my $attrs = shift @_;
1377 my $resultset = $self->result_source->resultset;
1379 if(defined $attrs) {
1380 $resultset = $resultset->search(undef, $attrs);
1383 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
1385 $self->throw_exception($self->{_orig_ident_failreason})
1386 if ! keys %$ident_cond;
1388 return $resultset->find($ident_cond);
1391 =head2 discard_changes ($attrs?)
1393 $row->discard_changes
1397 =item Arguments: none or $attrs
1399 =item Returns: self (updates object in-place)
1403 Re-selects the row from the database, losing any changes that had
1404 been made. Throws an exception if a proper C<WHERE> clause identifying
1405 the database row can not be constructed (i.e. if the original object
1406 does not contain its entire
1407 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>).
1409 This method can also be used to refresh from storage, retrieving any
1410 changes made since the row was last read from storage.
1412 $attrs, if supplied, is expected to be a hashref of attributes suitable for passing as the
1413 second argument to C<< $resultset->search($cond, $attrs) >>;
1415 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1416 storage, please kept in mind that if you L</discard_changes> on a row that you
1417 just updated or created, you should wrap the entire bit inside a transaction.
1418 Otherwise you run the risk that you insert or update to the master database
1419 but read from a replicant database that has not yet been updated from the
1420 master. This will result in unexpected results.
1424 sub discard_changes {
1425 my ($self, $attrs) = @_;
1426 return unless $self->in_storage; # Don't reload if we aren't real!
1428 # add a replication default to read from the master only
1429 $attrs = { force_pool => 'master', %{$attrs||{}} };
1431 if( my $current_storage = $self->get_from_storage($attrs)) {
1433 # Set $self to the current.
1434 %$self = %$current_storage;
1436 # Avoid a possible infinite loop with
1437 # sub DESTROY { $_[0]->discard_changes }
1438 bless $current_storage, 'Do::Not::Exist';
1443 $self->in_storage(0);
1449 =head2 throw_exception
1451 See L<DBIx::Class::Schema/throw_exception>.
1455 sub throw_exception {
1458 if (ref $self && ref $self->result_source ) {
1459 $self->result_source->throw_exception(@_)
1462 DBIx::Class::Exception->throw(@_);
1472 =item Arguments: none
1474 =item Returns: A list of primary key values
1478 Returns the primary key(s) for a row. Can't be called as a class method.
1479 Actually implemented in L<DBIx::Class::PK>
1485 Matt S. Trout <mst@shadowcatsystems.co.uk>
1489 You may distribute this code under the same terms as Perl itself.