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 # perform the insert - the storage will return everything it is asked to
347 # (autoinc primary columns and any retrieve_on_insert columns)
348 my %current_rowdata = $self->get_columns;
349 my $returned_cols = $storage->insert(
351 { %current_rowdata }, # what to insert, copy because the storage *will* change it
354 for (keys %$returned_cols) {
355 $self->store_column($_, $returned_cols->{$_})
356 # this ensures we fire store_column only once
357 # (some asshats like overriding it)
359 (! defined $current_rowdata{$_})
361 ( $current_rowdata{$_} ne $returned_cols->{$_})
365 $self->{_dirty_columns} = {};
366 $self->{related_resultsets} = {};
368 foreach my $relname (keys %related_stuff) {
369 next unless $source->has_relationship ($relname);
371 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
372 ? @{$related_stuff{$relname}}
373 : $related_stuff{$relname}
376 if (@cands && blessed $cands[0] && $cands[0]->isa('DBIx::Class::Row')
378 my $reverse = $source->reverse_relationship_info($relname);
379 foreach my $obj (@cands) {
380 $obj->set_from_related($_, $self) for keys %$reverse;
381 if ($self->__their_pk_needs_us($relname)) {
382 if (exists $self->{_ignore_at_insert}{$relname}) {
383 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
386 MULTICREATE_DEBUG and warn "MC $self inserting $relname $obj";
390 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
397 $self->in_storage(1);
398 delete $self->{_orig_ident};
399 delete $self->{_orig_ident_failreason};
400 delete $self->{_ignore_at_insert};
401 $rollback_guard->commit if $rollback_guard;
408 $row->in_storage; # Get value
409 $row->in_storage(1); # Set value
413 =item Arguments: none or 1|0
419 Indicates whether the object exists as a row in the database or
420 not. This is set to true when L<DBIx::Class::ResultSet/find>,
421 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
424 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
425 L</delete> on one, sets it to false.
430 my ($self, $val) = @_;
431 $self->{_in_storage} = $val if @_ > 1;
432 return $self->{_in_storage} ? 1 : 0;
437 $row->update(\%columns?)
441 =item Arguments: none or a hashref
443 =item Returns: The Row object
447 Throws an exception if the row object is not yet in the database,
448 according to L</in_storage>.
450 This method issues an SQL UPDATE query to commit any changes to the
451 object to the database if required (see L</get_dirty_columns>).
452 It throws an exception if a proper WHERE clause uniquely identifying
453 the database row can not be constructed (see
454 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
457 Also takes an optional hashref of C<< column_name => value >> pairs
458 to update on the object first. Be aware that the hashref will be
459 passed to C<set_inflated_columns>, which might edit it in place, so
460 don't rely on it being the same after a call to C<update>. If you
461 need to preserve the hashref, it is sufficient to pass a shallow copy
462 to C<update>, e.g. ( { %{ $href } } )
464 If the values passed or any of the column values set on the object
465 contain scalar references, e.g.:
467 $row->last_modified(\'NOW()');
469 $row->update({ last_modified => \'NOW()' });
471 The update will pass the values verbatim into SQL. (See
472 L<SQL::Abstract> docs). The values in your Row object will NOT change
473 as a result of the update call, if you want the object to be updated
474 with the actual values from the database, call L</discard_changes>
477 $row->update()->discard_changes();
479 To determine before calling this method, which column values have
480 changed and will be updated, call L</get_dirty_columns>.
482 To check if any columns will be updated, call L</is_changed>.
484 To force a column to be updated, call L</make_column_dirty> before
490 my ($self, $upd) = @_;
492 $self->set_inflated_columns($upd) if $upd;
494 my %to_update = $self->get_dirty_columns
497 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
498 $self->throw_exception( "Not in database" ) unless $self->in_storage;
500 $self->throw_exception($self->{_orig_ident_failreason})
501 if ! keys %$ident_cond;
503 my $rows = $self->result_source->storage->update(
504 $self->result_source, \%to_update, $ident_cond
507 $self->throw_exception( "Can't update ${self}: row not found" );
508 } elsif ($rows > 1) {
509 $self->throw_exception("Can't update ${self}: updated more than one row");
511 $self->{_dirty_columns} = {};
512 $self->{related_resultsets} = {};
513 delete $self->{_orig_ident};
523 =item Arguments: none
525 =item Returns: The Row object
529 Throws an exception if the object is not in the database according to
530 L</in_storage>. Also throws an exception if a proper WHERE clause
531 uniquely identifying the database row can not be constructed (see
532 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
535 The object is still perfectly usable, but L</in_storage> will
536 now return 0 and the object must be reinserted using L</insert>
537 before it can be used to L</update> the row again.
539 If you delete an object in a class with a C<has_many> relationship, an
540 attempt is made to delete all the related objects as well. To turn
541 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
542 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
543 database-level cascade or restrict will take precedence over a
544 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
545 main row first> and only then attempts to delete any remaining related
548 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
549 and the transaction subsequently fails, the row object will remain marked as
550 not being in storage. If you know for a fact that the object is still in
551 storage (i.e. by inspecting the cause of the transaction's failure), you can
552 use C<< $obj->in_storage(1) >> to restore consistency between the object and
553 the database. This would allow a subsequent C<< $obj->delete >> to work
556 See also L<DBIx::Class::ResultSet/delete>.
563 $self->throw_exception( "Not in database" ) unless $self->in_storage;
565 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
566 $self->throw_exception($self->{_orig_ident_failreason})
567 if ! keys %$ident_cond;
569 $self->result_source->storage->delete(
570 $self->result_source, $ident_cond
573 delete $self->{_orig_ident}; # no longer identifiable
574 $self->in_storage(undef);
577 my $rsrc = try { $self->result_source_instance }
578 or $self->throw_exception("Can't do class delete without a ResultSource instance");
580 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
581 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
582 $rsrc->resultset->search(@_)->delete;
589 my $val = $row->get_column($col);
593 =item Arguments: $columnname
595 =item Returns: The value of the column
599 Throws an exception if the column name given doesn't exist according
602 Returns a raw column value from the row object, if it has already
603 been fetched from the database or set by an accessor.
605 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
606 will be deflated and returned.
608 Note that if you used the C<columns> or the C<select/as>
609 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
610 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
611 this method will return C<undef> even if the database contains some value.
613 To retrieve all loaded column values as a hash, use L</get_columns>.
618 my ($self, $column) = @_;
619 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
620 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
621 if (exists $self->{_inflated_column}{$column}) {
622 return $self->store_column($column,
623 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
625 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
629 =head2 has_column_loaded
631 if ( $row->has_column_loaded($col) ) {
632 print "$col has been loaded from db";
637 =item Arguments: $columnname
643 Returns a true value if the column value has been loaded from the
644 database (or set locally).
648 sub has_column_loaded {
649 my ($self, $column) = @_;
650 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
651 return 1 if exists $self->{_inflated_column}{$column};
652 return exists $self->{_column_data}{$column};
657 my %data = $row->get_columns;
661 =item Arguments: none
663 =item Returns: A hash of columnname, value pairs.
667 Returns all loaded column data as a hash, containing raw values. To
668 get just one value for a particular column, use L</get_column>.
670 See L</get_inflated_columns> to get the inflated values.
676 if (exists $self->{_inflated_column}) {
677 foreach my $col (keys %{$self->{_inflated_column}}) {
678 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
679 unless exists $self->{_column_data}{$col};
682 return %{$self->{_column_data}};
685 =head2 get_dirty_columns
687 my %data = $row->get_dirty_columns;
691 =item Arguments: none
693 =item Returns: A hash of column, value pairs
697 Only returns the column, value pairs for those columns that have been
698 changed on this object since the last L</update> or L</insert> call.
700 See L</get_columns> to fetch all column/value pairs.
704 sub get_dirty_columns {
706 return map { $_ => $self->{_column_data}{$_} }
707 keys %{$self->{_dirty_columns}};
710 =head2 make_column_dirty
712 $row->make_column_dirty($col)
716 =item Arguments: $columnname
718 =item Returns: undefined
722 Throws an exception if the column does not exist.
724 Marks a column as having been changed regardless of whether it has
728 sub make_column_dirty {
729 my ($self, $column) = @_;
731 $self->throw_exception( "No such column '${column}'" )
732 unless exists $self->{_column_data}{$column} || $self->has_column($column);
734 # the entire clean/dirty code relies on exists, not on true/false
735 return 1 if exists $self->{_dirty_columns}{$column};
737 $self->{_dirty_columns}{$column} = 1;
739 # if we are just now making the column dirty, and if there is an inflated
740 # value, force it over the deflated one
741 if (exists $self->{_inflated_column}{$column}) {
742 $self->store_column($column,
743 $self->_deflated_column(
744 $column, $self->{_inflated_column}{$column}
750 =head2 get_inflated_columns
752 my %inflated_data = $obj->get_inflated_columns;
756 =item Arguments: none
758 =item Returns: A hash of column, object|value pairs
762 Returns a hash of all column keys and associated values. Values for any
763 columns set to use inflation will be inflated and returns as objects.
765 See L</get_columns> to get the uninflated values.
767 See L<DBIx::Class::InflateColumn> for how to setup inflation.
771 sub get_inflated_columns {
774 my $loaded_colinfo = $self->columns_info ([
775 grep { $self->has_column_loaded($_) } $self->columns
779 for my $col (keys %$loaded_colinfo) {
780 if (exists $loaded_colinfo->{$col}{accessor}) {
781 my $acc = $loaded_colinfo->{$col}{accessor};
782 $inflated{$col} = $self->$acc if defined $acc;
785 $inflated{$col} = $self->$col;
789 # return all loaded columns with the inflations overlayed on top
790 return %{ { $self->get_columns, %inflated } };
793 sub _is_column_numeric {
794 my ($self, $column) = @_;
795 my $colinfo = $self->column_info ($column);
797 # cache for speed (the object may *not* have a resultsource instance)
799 ! defined $colinfo->{is_numeric}
801 my $storage = try { $self->result_source->schema->storage }
803 $colinfo->{is_numeric} =
804 $storage->is_datatype_numeric ($colinfo->{data_type})
810 return $colinfo->{is_numeric};
815 $row->set_column($col => $val);
819 =item Arguments: $columnname, $value
821 =item Returns: $value
825 Sets a raw column value. If the new value is different from the old one,
826 the column is marked as dirty for when you next call L</update>.
828 If passed an object or reference as a value, this method will happily
829 attempt to store it, and a later L</insert> or L</update> will try and
830 stringify/numify as appropriate. To set an object to be deflated
831 instead, see L</set_inflated_columns>.
836 my ($self, $column, $new_value) = @_;
838 # if we can't get an ident condition on first try - mark the object as unidentifiable
839 # (by using an empty hashref) and store the error for further diag
840 unless ($self->{_orig_ident}) {
842 $self->{_orig_ident} = $self->ident_condition
845 $self->{_orig_ident_failreason} = $_;
846 $self->{_orig_ident} = {};
850 my $old_value = $self->get_column($column);
851 $new_value = $self->store_column($column, $new_value);
854 $self->{_dirty_columns}{$column}
856 $self->in_storage # no point tracking dirtyness on uninserted data
857 ? ! $self->_eq_column_values ($column, $old_value, $new_value)
862 # FIXME sadly the update code just checks for keys, not for their value
863 $self->{_dirty_columns}{$column} = 1;
865 # Clear out the relation/inflation cache related to this column
867 # FIXME - this is a quick *largely incorrect* hack, pending a more
868 # serious rework during the merge of single and filter rels
869 my $rels = $self->result_source->{_relationships};
870 for my $rel (keys %$rels) {
872 my $acc = $rels->{$rel}{attrs}{accessor} || '';
874 if ( $acc eq 'single' and $rels->{$rel}{attrs}{fk_columns}{$column} ) {
875 delete $self->{related_resultsets}{$rel};
876 delete $self->{_relationship_data}{$rel};
877 #delete $self->{_inflated_column}{$rel};
879 elsif ( $acc eq 'filter' and $rel eq $column) {
880 delete $self->{related_resultsets}{$rel};
881 #delete $self->{_relationship_data}{$rel};
882 delete $self->{_inflated_column}{$rel};
890 sub _eq_column_values {
891 my ($self, $col, $old, $new) = @_;
893 if (defined $old xor defined $new) {
896 elsif (not defined $old) { # both undef
899 elsif ($old eq $new) {
902 elsif ($self->_is_column_numeric($col)) { # do a numeric comparison if datatype allows it
912 $row->set_columns({ $col => $val, ... });
916 =item Arguments: \%columndata
918 =item Returns: The Row object
922 Sets multiple column, raw value pairs at once.
924 Works as L</set_column>.
929 my ($self,$data) = @_;
930 foreach my $col (keys %$data) {
931 $self->set_column($col,$data->{$col});
936 =head2 set_inflated_columns
938 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
942 =item Arguments: \%columndata
944 =item Returns: The Row object
948 Sets more than one column value at once. Any inflated values are
949 deflated and the raw values stored.
951 Any related values passed as Row objects, using the relation name as a
952 key, are reduced to the appropriate foreign key values and stored. If
953 instead of related row objects, a hashref of column, value data is
954 passed, will create the related object first then store.
956 Will even accept arrayrefs of data as a value to a
957 L<DBIx::Class::Relationship/has_many> key, and create the related
958 objects if necessary.
960 Be aware that the input hashref might be edited in place, so don't rely
961 on it being the same after a call to C<set_inflated_columns>. If you
962 need to preserve the hashref, it is sufficient to pass a shallow copy
963 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
965 See also L<DBIx::Class::Relationship::Base/set_from_related>.
969 sub set_inflated_columns {
970 my ( $self, $upd ) = @_;
971 foreach my $key (keys %$upd) {
972 if (ref $upd->{$key}) {
973 my $info = $self->relationship_info($key);
974 my $acc_type = $info->{attrs}{accessor} || '';
975 if ($acc_type eq 'single') {
976 my $rel = delete $upd->{$key};
977 $self->set_from_related($key => $rel);
978 $self->{_relationship_data}{$key} = $rel;
980 elsif ($acc_type eq 'multi') {
981 $self->throw_exception(
982 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
985 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
986 $self->set_inflated_column($key, delete $upd->{$key});
990 $self->set_columns($upd);
995 my $copy = $orig->copy({ change => $to, ... });
999 =item Arguments: \%replacementdata
1001 =item Returns: The Row object copy
1005 Inserts a new row into the database, as a copy of the original
1006 object. If a hashref of replacement data is supplied, these will take
1007 precedence over data in the original. Also any columns which have
1008 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
1009 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
1010 so that the database can insert its own autoincremented values into
1013 Relationships will be followed by the copy procedure B<only> if the
1014 relationship specifies a true value for its
1015 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1016 is set by default on C<has_many> relationships and unset on all others.
1021 my ($self, $changes) = @_;
1023 my $col_data = { %{$self->{_column_data}} };
1025 my $colinfo = $self->columns_info([ keys %$col_data ]);
1026 foreach my $col (keys %$col_data) {
1027 delete $col_data->{$col}
1028 if $colinfo->{$col}{is_auto_increment};
1031 my $new = { _column_data => $col_data };
1032 bless $new, ref $self;
1034 $new->result_source($self->result_source);
1035 $new->set_inflated_columns($changes);
1038 # Its possible we'll have 2 relations to the same Source. We need to make
1039 # sure we don't try to insert the same row twice else we'll violate unique
1041 my $rels_copied = {};
1043 foreach my $rel ($self->result_source->relationships) {
1044 my $rel_info = $self->result_source->relationship_info($rel);
1046 next unless $rel_info->{attrs}{cascade_copy};
1048 my $resolved = $self->result_source->_resolve_condition(
1049 $rel_info->{cond}, $rel, $new, $rel
1052 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1053 foreach my $related ($self->search_related($rel)) {
1054 my $id_str = join("\0", $related->id);
1055 next if $copied->{$id_str};
1056 $copied->{$id_str} = 1;
1057 my $rel_copy = $related->copy($resolved);
1066 $row->store_column($col => $val);
1070 =item Arguments: $columnname, $value
1072 =item Returns: The value sent to storage
1076 Set a raw value for a column without marking it as changed. This
1077 method is used internally by L</set_column> which you should probably
1080 This is the lowest level at which data is set on a row object,
1081 extend this method to catch all data setting methods.
1086 my ($self, $column, $value) = @_;
1087 $self->throw_exception( "No such column '${column}'" )
1088 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1089 $self->throw_exception( "set_column called for ${column} without value" )
1091 return $self->{_column_data}{$column} = $value;
1094 =head2 inflate_result
1096 Class->inflate_result($result_source, \%me, \%prefetch?)
1100 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1102 =item Returns: A Row object
1106 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1107 database and turn it into row objects call this method.
1109 Extend this method in your Result classes to hook into this process,
1110 for example to rebless the result into a different class.
1112 Reblessing can also be done more easily by setting C<result_class> in
1113 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1115 Different types of results can also be created from a particular
1116 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1120 sub inflate_result {
1121 my ($class, $source, $me, $prefetch) = @_;
1123 $source = $source->resolve
1124 if $source->isa('DBIx::Class::ResultSourceHandle');
1127 { _column_data => $me, _result_source => $source },
1128 ref $class || $class
1131 foreach my $pre (keys %{$prefetch||{}}) {
1133 my $pre_source = $source->related_source($pre)
1134 or $class->throw_exception("Can't prefetch non-existent relationship ${pre}");
1136 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1137 or $class->throw_exception("No accessor for prefetched $pre");
1140 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1141 @pre_vals = @{$prefetch->{$pre}};
1143 elsif ($accessor eq 'multi') {
1144 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor 'multi'");
1147 @pre_vals = $prefetch->{$pre};
1151 for my $me_pref (@pre_vals) {
1153 # FIXME - this should not be necessary
1154 # the collapser currently *could* return bogus elements with all
1155 # columns set to undef
1157 for (values %{$me_pref->[0]}) {
1163 next unless $has_def;
1165 push @pre_objects, $pre_source->result_class->inflate_result(
1166 $pre_source, @$me_pref
1170 if ($accessor eq 'single') {
1171 $new->{_relationship_data}{$pre} = $pre_objects[0];
1173 elsif ($accessor eq 'filter') {
1174 $new->{_inflated_column}{$pre} = $pre_objects[0];
1177 $new->related_resultset($pre)->set_cache(\@pre_objects);
1180 $new->in_storage (1);
1184 =head2 update_or_insert
1186 $row->update_or_insert
1190 =item Arguments: none
1192 =item Returns: Result of update or insert operation
1196 L</Update>s the object if it's already in the database, according to
1197 L</in_storage>, else L</insert>s it.
1199 =head2 insert_or_update
1201 $obj->insert_or_update
1203 Alias for L</update_or_insert>
1207 sub insert_or_update { shift->update_or_insert(@_) }
1209 sub update_or_insert {
1211 return ($self->in_storage ? $self->update : $self->insert);
1216 my @changed_col_names = $row->is_changed();
1217 if ($row->is_changed()) { ... }
1221 =item Arguments: none
1223 =item Returns: 0|1 or @columnnames
1227 In list context returns a list of columns with uncommited changes, or
1228 in scalar context returns a true value if there are uncommitted
1234 return keys %{shift->{_dirty_columns} || {}};
1237 =head2 is_column_changed
1239 if ($row->is_column_changed('col')) { ... }
1243 =item Arguments: $columname
1249 Returns a true value if the column has uncommitted changes.
1253 sub is_column_changed {
1254 my( $self, $col ) = @_;
1255 return exists $self->{_dirty_columns}->{$col};
1258 =head2 result_source
1260 my $resultsource = $row->result_source;
1264 =item Arguments: $result_source_instance
1266 =item Returns: a ResultSource instance
1270 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1275 $_[0]->throw_exception( 'result_source can be called on instances only' )
1279 ? $_[0]->{_result_source} = $_[1]
1281 # note this is a || not a ||=, the difference is important
1282 : $_[0]->{_result_source} || do {
1283 my $class = ref $_[0];
1284 $_[0]->can('result_source_instance')
1285 ? $_[0]->result_source_instance
1286 : $_[0]->throw_exception(
1287 "No result source instance registered for $class, did you forget to call $class->table(...) ?"
1293 =head2 register_column
1295 $column_info = { .... };
1296 $class->register_column($column_name, $column_info);
1300 =item Arguments: $columnname, \%columninfo
1302 =item Returns: undefined
1306 Registers a column on the class. If the column_info has an 'accessor'
1307 key, creates an accessor named after the value if defined; if there is
1308 no such key, creates an accessor with the same name as the column
1310 The column_info attributes are described in
1311 L<DBIx::Class::ResultSource/add_columns>
1315 sub register_column {
1316 my ($class, $col, $info) = @_;
1318 if (exists $info->{accessor}) {
1319 return unless defined $info->{accessor};
1320 $acc = [ $info->{accessor}, $col ];
1322 $class->mk_group_accessors('column' => $acc);
1325 =head2 get_from_storage
1327 my $copy = $row->get_from_storage($attrs)
1331 =item Arguments: \%attrs
1333 =item Returns: A Row object
1337 Fetches a fresh copy of the Row object from the database and returns it.
1338 Throws an exception if a proper WHERE clause identifying the database row
1339 can not be constructed (i.e. if the original object does not contain its
1341 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1342 ). If passed the \%attrs argument, will first apply these attributes to
1343 the resultset used to find the row.
1345 This copy can then be used to compare to an existing row object, to
1346 determine if any changes have been made in the database since it was
1349 To just update your Row object with any latest changes from the
1350 database, use L</discard_changes> instead.
1352 The \%attrs argument should be compatible with
1353 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1357 sub get_from_storage {
1358 my $self = shift @_;
1359 my $attrs = shift @_;
1360 my $resultset = $self->result_source->resultset;
1362 if(defined $attrs) {
1363 $resultset = $resultset->search(undef, $attrs);
1366 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
1368 $self->throw_exception($self->{_orig_ident_failreason})
1369 if ! keys %$ident_cond;
1371 return $resultset->find($ident_cond);
1374 =head2 discard_changes ($attrs?)
1376 $row->discard_changes
1380 =item Arguments: none or $attrs
1382 =item Returns: self (updates object in-place)
1386 Re-selects the row from the database, losing any changes that had
1387 been made. Throws an exception if a proper C<WHERE> clause identifying
1388 the database row can not be constructed (i.e. if the original object
1389 does not contain its entire
1390 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>).
1392 This method can also be used to refresh from storage, retrieving any
1393 changes made since the row was last read from storage.
1395 $attrs, if supplied, is expected to be a hashref of attributes suitable for passing as the
1396 second argument to C<< $resultset->search($cond, $attrs) >>;
1398 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1399 storage, please kept in mind that if you L</discard_changes> on a row that you
1400 just updated or created, you should wrap the entire bit inside a transaction.
1401 Otherwise you run the risk that you insert or update to the master database
1402 but read from a replicant database that has not yet been updated from the
1403 master. This will result in unexpected results.
1407 sub discard_changes {
1408 my ($self, $attrs) = @_;
1409 return unless $self->in_storage; # Don't reload if we aren't real!
1411 # add a replication default to read from the master only
1412 $attrs = { force_pool => 'master', %{$attrs||{}} };
1414 if( my $current_storage = $self->get_from_storage($attrs)) {
1416 # Set $self to the current.
1417 %$self = %$current_storage;
1419 # Avoid a possible infinite loop with
1420 # sub DESTROY { $_[0]->discard_changes }
1421 bless $current_storage, 'Do::Not::Exist';
1426 $self->in_storage(0);
1432 =head2 throw_exception
1434 See L<DBIx::Class::Schema/throw_exception>.
1438 sub throw_exception {
1441 if (ref $self && ref $self->result_source ) {
1442 $self->result_source->throw_exception(@_)
1445 DBIx::Class::Exception->throw(@_);
1455 =item Arguments: none
1457 =item Returns: A list of primary key values
1461 Returns the primary key(s) for a row. Can't be called as a class method.
1462 Actually implemented in L<DBIx::Class::PK>
1468 Matt S. Trout <mst@shadowcatsystems.co.uk>
1472 You may distribute this code under the same terms as Perl itself.