1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
8 use DBIx::Class::Exception;
17 $ENV{DBIC_MULTICREATE_DEBUG}
22 __PACKAGE__->mk_group_accessors('simple' => qw/_source_handle/);
26 DBIx::Class::Row - Basic row methods
32 This class is responsible for defining and doing basic operations on rows
33 derived from L<DBIx::Class::ResultSource> objects.
35 Row objects are returned from L<DBIx::Class::ResultSet>s using the
36 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
37 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
38 as well as invocations of 'single' (
39 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
40 L<has_one|DBIx::Class::Relationship/has_one> or
41 L<might_have|DBIx::Class::Relationship/might_have>)
42 relationship accessors of L<DBIx::Class::Row> objects.
48 my $row = My::Class->new(\%attrs);
50 my $row = $schema->resultset('MySource')->new(\%colsandvalues);
54 =item Arguments: \%attrs or \%colsandvalues
56 =item Returns: A Row object
60 While you can create a new row object by calling C<new> directly on
61 this class, you are better off calling it on a
62 L<DBIx::Class::ResultSet> object.
64 When calling it directly, you will not get a complete, usable row
65 object until you pass or set the C<source_handle> attribute, to a
66 L<DBIx::Class::ResultSource> instance that is attached to a
67 L<DBIx::Class::Schema> with a valid connection.
69 C<$attrs> is a hashref of column name, value data. It can also contain
70 some other attributes such as the C<source_handle>.
72 Passing an object, or an arrayref of objects as a value will call
73 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
74 passed a hashref or an arrayref of hashrefs as the value, these will
75 be turned into objects via new_related, and treated as if you had
78 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
80 Please note that if a value is not passed to new, no value will be sent
81 in the SQL INSERT call, and the column will therefore assume whatever
82 default value was specified in your database. While DBIC will retrieve the
83 value of autoincrement columns, it will never make an explicit database
84 trip to retrieve default values assigned by the RDBMS. You can explicitly
85 request that all values be fetched back from the database by calling
86 L</discard_changes>, or you can supply an explicit C<undef> to columns
87 with NULL as the default, and save yourself a SELECT.
91 The behavior described above will backfire if you use a foreign key column
92 with a database-defined default. If you call the relationship accessor on
93 an object that doesn't have a set value for the FK column, DBIC will throw
94 an exception, as it has no way of knowing the PK of the related object (if
99 ## It needs to store the new objects somewhere, and call insert on that list later when insert is called on this object. We may need an accessor for these so the user can retrieve them, if just doing ->new().
100 ## This only works because DBIC doesnt yet care to check whether the new_related objects have been passed all their mandatory columns
101 ## When doing the later insert, we need to make sure the PKs are set.
102 ## using _relationship_data in new and funky ways..
103 ## check Relationship::CascadeActions and Relationship::Accessor for compat
106 sub __new_related_find_or_new_helper {
107 my ($self, $relname, $data) = @_;
109 # create a mock-object so all new/set_column component overrides will run:
110 my $rel_rs = $self->result_source
111 ->related_source($relname)
113 my $new_rel_obj = $rel_rs->new_result($data);
114 my $proc_data = { $new_rel_obj->get_columns };
116 if ($self->__their_pk_needs_us($relname)) {
117 MULTICREATE_DEBUG and warn "MC $self constructing $relname via new_result";
120 elsif ($self->result_source->_pk_depends_on($relname, $proc_data )) {
121 if (! keys %$proc_data) {
122 # there is nothing to search for - blind create
123 MULTICREATE_DEBUG and warn "MC $self constructing default-insert $relname";
126 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new";
127 # this is not *really* find or new, as we don't want to double-new the
128 # data (thus potentially double encoding or whatever)
129 my $exists = $rel_rs->find ($proc_data);
130 return $exists if $exists;
135 my $us = $self->source_name;
136 $self->throw_exception ("'$us' neither depends nor is depended on by '$relname', something is wrong...");
140 sub __their_pk_needs_us { # this should maybe be in resultsource.
141 my ($self, $relname) = @_;
142 my $source = $self->result_source;
143 my $reverse = $source->reverse_relationship_info($relname);
144 my $rel_source = $source->related_source($relname);
145 my $us = { $self->get_columns };
146 foreach my $key (keys %$reverse) {
147 # if their primary key depends on us, then we have to
148 # just create a result and we'll fill it out afterwards
149 return 1 if $rel_source->_pk_depends_on($key, $us);
155 my ($class, $attrs) = @_;
156 $class = ref $class if ref $class;
163 if (my $handle = delete $attrs->{-source_handle}) {
164 $new->_source_handle($handle);
168 if ($source = delete $attrs->{-result_source}) {
169 $new->result_source($source);
172 if (my $related = delete $attrs->{-cols_from_relations}) {
173 @{$new->{_ignore_at_insert}={}}{@$related} = ();
177 $new->throw_exception("attrs must be a hashref")
178 unless ref($attrs) eq 'HASH';
180 my ($related,$inflated);
182 foreach my $key (keys %$attrs) {
183 if (ref $attrs->{$key}) {
184 ## Can we extract this lot to use with update(_or .. ) ?
185 $new->throw_exception("Can't do multi-create without result source")
187 my $info = $source->relationship_info($key);
188 my $acc_type = $info->{attrs}{accessor} || '';
189 if ($acc_type eq 'single') {
190 my $rel_obj = delete $attrs->{$key};
191 if(!Scalar::Util::blessed($rel_obj)) {
192 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
195 if ($rel_obj->in_storage) {
196 $new->{_rel_in_storage}{$key} = 1;
197 $new->set_from_related($key, $rel_obj);
199 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj\n";
202 $related->{$key} = $rel_obj;
205 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
206 my $others = delete $attrs->{$key};
207 my $total = @$others;
209 foreach my $idx (0 .. $#$others) {
210 my $rel_obj = $others->[$idx];
211 if(!Scalar::Util::blessed($rel_obj)) {
212 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
215 if ($rel_obj->in_storage) {
216 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
218 MULTICREATE_DEBUG and
219 warn "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
221 push(@objects, $rel_obj);
223 $related->{$key} = \@objects;
226 elsif ($acc_type eq 'filter') {
227 ## 'filter' should disappear and get merged in with 'single' above!
228 my $rel_obj = delete $attrs->{$key};
229 if(!Scalar::Util::blessed($rel_obj)) {
230 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
232 if ($rel_obj->in_storage) {
233 $new->{_rel_in_storage}{$key} = 1;
236 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj";
238 $inflated->{$key} = $rel_obj;
240 } elsif ($class->has_column($key)
241 && $class->column_info($key)->{_inflate_info}) {
242 $inflated->{$key} = $attrs->{$key};
246 $new->throw_exception("No such column $key on $class")
247 unless $class->has_column($key);
248 $new->store_column($key => $attrs->{$key});
251 $new->{_relationship_data} = $related if $related;
252 $new->{_inflated_column} = $inflated if $inflated;
264 =item Arguments: none
266 =item Returns: The Row object
270 Inserts an object previously created by L</new> into the database if
271 it isn't already in there. Returns the object itself. Requires the
272 object's result source to be set, or the class to have a
273 result_source_instance method. To insert an entirely new row into
274 the database, use C<create> (see L<DBIx::Class::ResultSet/create>).
276 To fetch an uninserted row object, call
277 L<new|DBIx::Class::ResultSet/new> on a resultset.
279 This will also insert any uninserted, related objects held inside this
280 one, see L<DBIx::Class::ResultSet/create> for more details.
286 return $self if $self->in_storage;
287 my $source = $self->result_source;
288 $source ||= $self->result_source($self->result_source_instance)
289 if $self->can('result_source_instance');
290 $self->throw_exception("No result_source set on this object; can't insert")
295 # Check if we stored uninserted relobjs here in new()
296 my %related_stuff = (%{$self->{_relationship_data} || {}},
297 %{$self->{_inflated_column} || {}});
299 # insert what needs to be inserted before us
301 for my $relname (keys %related_stuff) {
302 my $rel_obj = $related_stuff{$relname};
304 if (! $self->{_rel_in_storage}{$relname}) {
305 next unless (Scalar::Util::blessed($rel_obj)
306 && $rel_obj->isa('DBIx::Class::Row'));
308 next unless $source->_pk_depends_on(
309 $relname, { $rel_obj->get_columns }
312 # The guard will save us if we blow out of this scope via die
313 $rollback_guard ||= $source->storage->txn_scope_guard;
315 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
317 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_inflated_columns };
320 # if there are no keys - nothing to search for
321 if (keys %$them and $existing = $self->result_source
322 ->related_source($relname)
326 %{$rel_obj} = %{$existing};
332 $self->{_rel_in_storage}{$relname} = 1;
335 $self->set_from_related($relname, $rel_obj);
336 delete $related_stuff{$relname};
339 # start a transaction here if not started yet and there is more stuff
341 if (keys %related_stuff) {
342 $rollback_guard ||= $source->storage->txn_scope_guard
348 for ($self->primary_columns) {
350 not defined $self->get_column($_)
352 (ref($self->get_column($_)) eq 'SCALAR')
354 my $col_info = $source->column_info($_);
355 $auto_pri{$_} = $auto_idx++ unless $col_info->{auto_nextval}; # auto_nextval's are pre-fetched in the storage
359 MULTICREATE_DEBUG and do {
360 no warnings 'uninitialized';
361 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
363 my $updated_cols = $source->storage->insert(
365 { $self->get_columns },
367 ? { returning => [ sort { $auto_pri{$a} cmp $auto_pri{$b} } keys %auto_pri ] }
372 foreach my $col (keys %$updated_cols) {
373 $self->store_column($col, $updated_cols->{$col});
374 delete $auto_pri{$col};
377 if (keys %auto_pri) {
378 my @missing = sort { $auto_pri{$a} <=> $auto_pri{$b} } keys %auto_pri;
379 MULTICREATE_DEBUG and warn "MC $self fetching missing PKs ".join(', ', @missing )."\n";
380 my $storage = $self->result_source->storage;
381 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
382 unless $storage->can('last_insert_id');
383 my @ids = $storage->last_insert_id($self->result_source, @missing);
384 $self->throw_exception( "Can't get last insert id" )
385 unless (@ids == @missing);
386 $self->store_column($missing[$_] => $ids[$_]) for 0 .. $#missing;
389 $self->{_dirty_columns} = {};
390 $self->{related_resultsets} = {};
392 foreach my $relname (keys %related_stuff) {
393 next unless $source->has_relationship ($relname);
395 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
396 ? @{$related_stuff{$relname}}
397 : $related_stuff{$relname}
401 && Scalar::Util::blessed($cands[0])
402 && $cands[0]->isa('DBIx::Class::Row')
404 my $reverse = $source->reverse_relationship_info($relname);
405 foreach my $obj (@cands) {
406 $obj->set_from_related($_, $self) for keys %$reverse;
407 my $them = { %{$obj->{_relationship_data} || {} }, $obj->get_inflated_columns };
408 if ($self->__their_pk_needs_us($relname)) {
409 if (exists $self->{_ignore_at_insert}{$relname}) {
410 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
412 MULTICREATE_DEBUG and warn "MC $self re-creating $relname $obj";
413 my $re = $self->result_source
414 ->related_source($relname)
418 MULTICREATE_DEBUG and warn "MC $self new $relname $obj";
421 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
428 $self->in_storage(1);
429 delete $self->{_orig_ident};
430 delete $self->{_ignore_at_insert};
431 $rollback_guard->commit if $rollback_guard;
438 $row->in_storage; # Get value
439 $row->in_storage(1); # Set value
443 =item Arguments: none or 1|0
449 Indicates whether the object exists as a row in the database or
450 not. This is set to true when L<DBIx::Class::ResultSet/find>,
451 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
454 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
455 L</delete> on one, sets it to false.
460 my ($self, $val) = @_;
461 $self->{_in_storage} = $val if @_ > 1;
462 return $self->{_in_storage} ? 1 : 0;
467 $row->update(\%columns?)
471 =item Arguments: none or a hashref
473 =item Returns: The Row object
477 Throws an exception if the row object is not yet in the database,
478 according to L</in_storage>.
480 This method issues an SQL UPDATE query to commit any changes to the
481 object to the database if required (see L</get_dirty_columns>).
482 It throws an exception if a proper WHERE clause uniquely identifying
483 the database row can not be constructed (see
484 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
487 Also takes an optional hashref of C<< column_name => value> >> pairs
488 to update on the object first. Be aware that the hashref will be
489 passed to C<set_inflated_columns>, which might edit it in place, so
490 don't rely on it being the same after a call to C<update>. If you
491 need to preserve the hashref, it is sufficient to pass a shallow copy
492 to C<update>, e.g. ( { %{ $href } } )
494 If the values passed or any of the column values set on the object
495 contain scalar references, e.g.:
497 $row->last_modified(\'NOW()');
499 $row->update({ last_modified => \'NOW()' });
501 The update will pass the values verbatim into SQL. (See
502 L<SQL::Abstract> docs). The values in your Row object will NOT change
503 as a result of the update call, if you want the object to be updated
504 with the actual values from the database, call L</discard_changes>
507 $row->update()->discard_changes();
509 To determine before calling this method, which column values have
510 changed and will be updated, call L</get_dirty_columns>.
512 To check if any columns will be updated, call L</is_changed>.
514 To force a column to be updated, call L</make_column_dirty> before
520 my ($self, $upd) = @_;
521 $self->throw_exception( "Not in database" ) unless $self->in_storage;
523 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
525 $self->throw_exception('Unable to update a row with incomplete or no identity')
526 if ! keys %$ident_cond;
528 $self->set_inflated_columns($upd) if $upd;
529 my %to_update = $self->get_dirty_columns;
530 return $self unless keys %to_update;
531 my $rows = $self->result_source->storage->update(
532 $self->result_source, \%to_update, $ident_cond
535 $self->throw_exception( "Can't update ${self}: row not found" );
536 } elsif ($rows > 1) {
537 $self->throw_exception("Can't update ${self}: updated more than one row");
539 $self->{_dirty_columns} = {};
540 $self->{related_resultsets} = {};
541 delete $self->{_orig_ident};
551 =item Arguments: none
553 =item Returns: The Row object
557 Throws an exception if the object is not in the database according to
558 L</in_storage>. Also throws an exception if a proper WHERE clause
559 uniquely identifying the database row can not be constructed (see
560 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
563 The object is still perfectly usable, but L</in_storage> will
564 now return 0 and the object must be reinserted using L</insert>
565 before it can be used to L</update> the row again.
567 If you delete an object in a class with a C<has_many> relationship, an
568 attempt is made to delete all the related objects as well. To turn
569 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
570 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
571 database-level cascade or restrict will take precedence over a
572 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
573 main row first> and only then attempts to delete any remaining related
576 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
577 and the transaction subsequently fails, the row object will remain marked as
578 not being in storage. If you know for a fact that the object is still in
579 storage (i.e. by inspecting the cause of the transaction's failure), you can
580 use C<< $obj->in_storage(1) >> to restore consistency between the object and
581 the database. This would allow a subsequent C<< $obj->delete >> to work
584 See also L<DBIx::Class::ResultSet/delete>.
591 $self->throw_exception( "Not in database" ) unless $self->in_storage;
593 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
594 $self->throw_exception('Unable to delete a row with incomplete or no identity')
595 if ! keys %$ident_cond;
597 $self->result_source->storage->delete(
598 $self->result_source, $ident_cond
601 delete $self->{_orig_ident};
602 $self->in_storage(undef);
605 $self->throw_exception("Can't do class delete without a ResultSource instance")
606 unless $self->can('result_source_instance');
607 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
608 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
609 $self->result_source_instance->resultset->search(@_)->delete;
616 my $val = $row->get_column($col);
620 =item Arguments: $columnname
622 =item Returns: The value of the column
626 Throws an exception if the column name given doesn't exist according
629 Returns a raw column value from the row object, if it has already
630 been fetched from the database or set by an accessor.
632 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
633 will be deflated and returned.
635 Note that if you used the C<columns> or the C<select/as>
636 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
637 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
638 this method will return C<undef> even if the database contains some value.
640 To retrieve all loaded column values as a hash, use L</get_columns>.
645 my ($self, $column) = @_;
646 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
647 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
648 if (exists $self->{_inflated_column}{$column}) {
649 return $self->store_column($column,
650 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
652 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
656 =head2 has_column_loaded
658 if ( $row->has_column_loaded($col) ) {
659 print "$col has been loaded from db";
664 =item Arguments: $columnname
670 Returns a true value if the column value has been loaded from the
671 database (or set locally).
675 sub has_column_loaded {
676 my ($self, $column) = @_;
677 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
678 return 1 if exists $self->{_inflated_column}{$column};
679 return exists $self->{_column_data}{$column};
684 my %data = $row->get_columns;
688 =item Arguments: none
690 =item Returns: A hash of columnname, value pairs.
694 Returns all loaded column data as a hash, containing raw values. To
695 get just one value for a particular column, use L</get_column>.
697 See L</get_inflated_columns> to get the inflated values.
703 if (exists $self->{_inflated_column}) {
704 foreach my $col (keys %{$self->{_inflated_column}}) {
705 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
706 unless exists $self->{_column_data}{$col};
709 return %{$self->{_column_data}};
712 =head2 get_dirty_columns
714 my %data = $row->get_dirty_columns;
718 =item Arguments: none
720 =item Returns: A hash of column, value pairs
724 Only returns the column, value pairs for those columns that have been
725 changed on this object since the last L</update> or L</insert> call.
727 See L</get_columns> to fetch all column/value pairs.
731 sub get_dirty_columns {
733 return map { $_ => $self->{_column_data}{$_} }
734 keys %{$self->{_dirty_columns}};
737 =head2 make_column_dirty
739 $row->make_column_dirty($col)
743 =item Arguments: $columnname
745 =item Returns: undefined
749 Throws an exception if the column does not exist.
751 Marks a column as having been changed regardless of whether it has
755 sub make_column_dirty {
756 my ($self, $column) = @_;
758 $self->throw_exception( "No such column '${column}'" )
759 unless exists $self->{_column_data}{$column} || $self->has_column($column);
761 # the entire clean/dirty code relies on exists, not on true/false
762 return 1 if exists $self->{_dirty_columns}{$column};
764 $self->{_dirty_columns}{$column} = 1;
766 # if we are just now making the column dirty, and if there is an inflated
767 # value, force it over the deflated one
768 if (exists $self->{_inflated_column}{$column}) {
769 $self->store_column($column,
770 $self->_deflated_column(
771 $column, $self->{_inflated_column}{$column}
777 =head2 get_inflated_columns
779 my %inflated_data = $obj->get_inflated_columns;
783 =item Arguments: none
785 =item Returns: A hash of column, object|value pairs
789 Returns a hash of all column keys and associated values. Values for any
790 columns set to use inflation will be inflated and returns as objects.
792 See L</get_columns> to get the uninflated values.
794 See L<DBIx::Class::InflateColumn> for how to setup inflation.
798 sub get_inflated_columns {
801 my %loaded_colinfo = (map
802 { $_ => $self->column_info($_) }
803 (grep { $self->has_column_loaded($_) } $self->columns)
807 for my $col (keys %loaded_colinfo) {
808 if (exists $loaded_colinfo{$col}{accessor}) {
809 my $acc = $loaded_colinfo{$col}{accessor};
810 $inflated{$col} = $self->$acc if defined $acc;
813 $inflated{$col} = $self->$col;
817 # return all loaded columns with the inflations overlayed on top
818 return ($self->get_columns, %inflated);
821 sub _is_column_numeric {
822 my ($self, $column) = @_;
823 my $colinfo = $self->column_info ($column);
825 # cache for speed (the object may *not* have a resultsource instance)
826 if (not defined $colinfo->{is_numeric} && $self->_source_handle) {
827 $colinfo->{is_numeric} =
828 $self->result_source->schema->storage->is_datatype_numeric ($colinfo->{data_type})
834 return $colinfo->{is_numeric};
839 $row->set_column($col => $val);
843 =item Arguments: $columnname, $value
845 =item Returns: $value
849 Sets a raw column value. If the new value is different from the old one,
850 the column is marked as dirty for when you next call L</update>.
852 If passed an object or reference as a value, this method will happily
853 attempt to store it, and a later L</insert> or L</update> will try and
854 stringify/numify as appropriate. To set an object to be deflated
855 instead, see L</set_inflated_columns>.
860 my ($self, $column, $new_value) = @_;
862 # if we can't get an ident condition on first try - mark the object as unidentifiable
863 $self->{_orig_ident} ||= (eval { $self->ident_condition }) || {};
865 my $old_value = $self->get_column($column);
866 $new_value = $self->store_column($column, $new_value);
869 if (!$self->in_storage) { # no point tracking dirtyness on uninserted data
872 elsif (defined $old_value xor defined $new_value) {
875 elsif (not defined $old_value) { # both undef
878 elsif ($old_value eq $new_value) {
881 else { # do a numeric comparison if datatype allows it
882 if ($self->_is_column_numeric($column)) {
883 $dirty = $old_value != $new_value;
890 # sadly the update code just checks for keys, not for their value
891 $self->{_dirty_columns}{$column} = 1 if $dirty;
893 # XXX clear out the relation cache for this column
894 delete $self->{related_resultsets}{$column};
901 $row->set_columns({ $col => $val, ... });
905 =item Arguments: \%columndata
907 =item Returns: The Row object
911 Sets multiple column, raw value pairs at once.
913 Works as L</set_column>.
918 my ($self,$data) = @_;
919 foreach my $col (keys %$data) {
920 $self->set_column($col,$data->{$col});
925 =head2 set_inflated_columns
927 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
931 =item Arguments: \%columndata
933 =item Returns: The Row object
937 Sets more than one column value at once. Any inflated values are
938 deflated and the raw values stored.
940 Any related values passed as Row objects, using the relation name as a
941 key, are reduced to the appropriate foreign key values and stored. If
942 instead of related row objects, a hashref of column, value data is
943 passed, will create the related object first then store.
945 Will even accept arrayrefs of data as a value to a
946 L<DBIx::Class::Relationship/has_many> key, and create the related
947 objects if necessary.
949 Be aware that the input hashref might be edited in place, so don't rely
950 on it being the same after a call to C<set_inflated_columns>. If you
951 need to preserve the hashref, it is sufficient to pass a shallow copy
952 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
954 See also L<DBIx::Class::Relationship::Base/set_from_related>.
958 sub set_inflated_columns {
959 my ( $self, $upd ) = @_;
960 foreach my $key (keys %$upd) {
961 if (ref $upd->{$key}) {
962 my $info = $self->relationship_info($key);
963 my $acc_type = $info->{attrs}{accessor} || '';
964 if ($acc_type eq 'single') {
965 my $rel = delete $upd->{$key};
966 $self->set_from_related($key => $rel);
967 $self->{_relationship_data}{$key} = $rel;
969 elsif ($acc_type eq 'multi') {
970 $self->throw_exception(
971 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
974 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
975 $self->set_inflated_column($key, delete $upd->{$key});
979 $self->set_columns($upd);
984 my $copy = $orig->copy({ change => $to, ... });
988 =item Arguments: \%replacementdata
990 =item Returns: The Row object copy
994 Inserts a new row into the database, as a copy of the original
995 object. If a hashref of replacement data is supplied, these will take
996 precedence over data in the original. Also any columns which have
997 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
998 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
999 so that the database can insert its own autoincremented values into
1002 Relationships will be followed by the copy procedure B<only> if the
1003 relationship specifies a true value for its
1004 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1005 is set by default on C<has_many> relationships and unset on all others.
1010 my ($self, $changes) = @_;
1012 my $col_data = { %{$self->{_column_data}} };
1013 foreach my $col (keys %$col_data) {
1014 delete $col_data->{$col}
1015 if $self->result_source->column_info($col)->{is_auto_increment};
1018 my $new = { _column_data => $col_data };
1019 bless $new, ref $self;
1021 $new->result_source($self->result_source);
1022 $new->set_inflated_columns($changes);
1025 # Its possible we'll have 2 relations to the same Source. We need to make
1026 # sure we don't try to insert the same row twice else we'll violate unique
1028 my $rels_copied = {};
1030 foreach my $rel ($self->result_source->relationships) {
1031 my $rel_info = $self->result_source->relationship_info($rel);
1033 next unless $rel_info->{attrs}{cascade_copy};
1035 my $resolved = $self->result_source->_resolve_condition(
1036 $rel_info->{cond}, $rel, $new
1039 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1040 foreach my $related ($self->search_related($rel)) {
1041 my $id_str = join("\0", $related->id);
1042 next if $copied->{$id_str};
1043 $copied->{$id_str} = 1;
1044 my $rel_copy = $related->copy($resolved);
1053 $row->store_column($col => $val);
1057 =item Arguments: $columnname, $value
1059 =item Returns: The value sent to storage
1063 Set a raw value for a column without marking it as changed. This
1064 method is used internally by L</set_column> which you should probably
1067 This is the lowest level at which data is set on a row object,
1068 extend this method to catch all data setting methods.
1073 my ($self, $column, $value) = @_;
1074 $self->throw_exception( "No such column '${column}'" )
1075 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1076 $self->throw_exception( "set_column called for ${column} without value" )
1078 return $self->{_column_data}{$column} = $value;
1081 =head2 inflate_result
1083 Class->inflate_result($result_source, \%me, \%prefetch?)
1087 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1089 =item Returns: A Row object
1093 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1094 database and turn it into row objects call this method.
1096 Extend this method in your Result classes to hook into this process,
1097 for example to rebless the result into a different class.
1099 Reblessing can also be done more easily by setting C<result_class> in
1100 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1102 Different types of results can also be created from a particular
1103 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1107 sub inflate_result {
1108 my ($class, $source, $me, $prefetch) = @_;
1110 my ($source_handle) = $source;
1112 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
1113 $source = $source_handle->resolve
1116 $source_handle = $source->handle
1120 _source_handle => $source_handle,
1121 _column_data => $me,
1123 bless $new, (ref $class || $class);
1125 foreach my $pre (keys %{$prefetch||{}}) {
1127 my $pre_source = $source->related_source($pre)
1128 or $class->throw_exception("Can't prefetch non-existent relationship ${pre}");
1130 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1131 or $class->throw_exception("No accessor for prefetched $pre");
1134 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1135 @pre_vals = @{$prefetch->{$pre}};
1137 elsif ($accessor eq 'multi') {
1138 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor 'multi'");
1141 @pre_vals = $prefetch->{$pre};
1145 for my $me_pref (@pre_vals) {
1147 # FIXME - this should not be necessary
1148 # the collapser currently *could* return bogus elements with all
1149 # columns set to undef
1151 for (values %{$me_pref->[0]}) {
1157 next unless $has_def;
1159 push @pre_objects, $pre_source->result_class->inflate_result(
1160 $pre_source, @$me_pref
1164 if ($accessor eq 'single') {
1165 $new->{_relationship_data}{$pre} = $pre_objects[0];
1167 elsif ($accessor eq 'filter') {
1168 $new->{_inflated_column}{$pre} = $pre_objects[0];
1171 $new->related_resultset($pre)->set_cache(\@pre_objects);
1174 $new->in_storage (1);
1178 =head2 update_or_insert
1180 $row->update_or_insert
1184 =item Arguments: none
1186 =item Returns: Result of update or insert operation
1190 L</Update>s the object if it's already in the database, according to
1191 L</in_storage>, else L</insert>s it.
1193 =head2 insert_or_update
1195 $obj->insert_or_update
1197 Alias for L</update_or_insert>
1201 sub insert_or_update { shift->update_or_insert(@_) }
1203 sub update_or_insert {
1205 return ($self->in_storage ? $self->update : $self->insert);
1210 my @changed_col_names = $row->is_changed();
1211 if ($row->is_changed()) { ... }
1215 =item Arguments: none
1217 =item Returns: 0|1 or @columnnames
1221 In list context returns a list of columns with uncommited changes, or
1222 in scalar context returns a true value if there are uncommitted
1228 return keys %{shift->{_dirty_columns} || {}};
1231 =head2 is_column_changed
1233 if ($row->is_column_changed('col')) { ... }
1237 =item Arguments: $columname
1243 Returns a true value if the column has uncommitted changes.
1247 sub is_column_changed {
1248 my( $self, $col ) = @_;
1249 return exists $self->{_dirty_columns}->{$col};
1252 =head2 result_source
1254 my $resultsource = $row->result_source;
1258 =item Arguments: none
1260 =item Returns: a ResultSource instance
1264 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1272 $self->_source_handle($_[0]->handle);
1274 $self->_source_handle->resolve;
1278 =head2 register_column
1280 $column_info = { .... };
1281 $class->register_column($column_name, $column_info);
1285 =item Arguments: $columnname, \%columninfo
1287 =item Returns: undefined
1291 Registers a column on the class. If the column_info has an 'accessor'
1292 key, creates an accessor named after the value if defined; if there is
1293 no such key, creates an accessor with the same name as the column
1295 The column_info attributes are described in
1296 L<DBIx::Class::ResultSource/add_columns>
1300 sub register_column {
1301 my ($class, $col, $info) = @_;
1303 if (exists $info->{accessor}) {
1304 return unless defined $info->{accessor};
1305 $acc = [ $info->{accessor}, $col ];
1307 $class->mk_group_accessors('column' => $acc);
1310 =head2 get_from_storage
1312 my $copy = $row->get_from_storage($attrs)
1316 =item Arguments: \%attrs
1318 =item Returns: A Row object
1322 Fetches a fresh copy of the Row object from the database and returns it.
1323 Throws an exception if a proper WHERE clause identifying the database row
1324 can not be constructed (i.e. if the original object does not contain its
1326 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1327 ). If passed the \%attrs argument, will first apply these attributes to
1328 the resultset used to find the row.
1330 This copy can then be used to compare to an existing row object, to
1331 determine if any changes have been made in the database since it was
1334 To just update your Row object with any latest changes from the
1335 database, use L</discard_changes> instead.
1337 The \%attrs argument should be compatible with
1338 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1342 sub get_from_storage {
1343 my $self = shift @_;
1344 my $attrs = shift @_;
1345 my $resultset = $self->result_source->resultset;
1347 if(defined $attrs) {
1348 $resultset = $resultset->search(undef, $attrs);
1351 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
1353 $self->throw_exception('Unable to requery a row with incomplete or no identity')
1354 if ! keys %$ident_cond;
1356 return $resultset->find($ident_cond);
1359 =head2 discard_changes ($attrs)
1361 Re-selects the row from the database, losing any changes that had
1362 been made. Throws an exception if a proper WHERE clause identifying
1363 the database row can not be constructed (i.e. if the original object
1364 does not contain its entire
1365 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1368 This method can also be used to refresh from storage, retrieving any
1369 changes made since the row was last read from storage.
1371 $attrs is expected to be a hashref of attributes suitable for passing as the
1372 second argument to $resultset->search($cond, $attrs);
1376 sub discard_changes {
1377 my ($self, $attrs) = @_;
1378 delete $self->{_dirty_columns};
1379 return unless $self->in_storage; # Don't reload if we aren't real!
1381 # add a replication default to read from the master only
1382 $attrs = { force_pool => 'master', %{$attrs||{}} };
1384 if( my $current_storage = $self->get_from_storage($attrs)) {
1386 # Set $self to the current.
1387 %$self = %$current_storage;
1389 # Avoid a possible infinite loop with
1390 # sub DESTROY { $_[0]->discard_changes }
1391 bless $current_storage, 'Do::Not::Exist';
1396 $self->in_storage(0);
1402 =head2 throw_exception
1404 See L<DBIx::Class::Schema/throw_exception>.
1408 sub throw_exception {
1411 if (ref $self && ref $self->result_source && $self->result_source->schema) {
1412 $self->result_source->schema->throw_exception(@_)
1415 DBIx::Class::Exception->throw(@_);
1425 =item Arguments: none
1427 =item Returns: A list of primary key values
1431 Returns the primary key(s) for a row. Can't be called as a class method.
1432 Actually implemented in L<DBIx::Class::PK>
1434 =head2 discard_changes
1436 $row->discard_changes
1440 =item Arguments: none
1442 =item Returns: nothing (updates object in-place)
1446 Retrieves and sets the row object data from the database, losing any
1449 This method can also be used to refresh from storage, retrieving any
1450 changes made since the row was last read from storage. Actually
1451 implemented in L<DBIx::Class::PK>
1453 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1454 storage, please kept in mind that if you L</discard_changes> on a row that you
1455 just updated or created, you should wrap the entire bit inside a transaction.
1456 Otherwise you run the risk that you insert or update to the master database
1457 but read from a replicant database that has not yet been updated from the
1458 master. This will result in unexpected results.
1466 Matt S. Trout <mst@shadowcatsystems.co.uk>
1470 You may distribute this code under the same terms as Perl itself.