1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
8 use DBIx::Class::Exception;
17 $ENV{DBIC_MULTICREATE_DEBUG}
22 __PACKAGE__->mk_group_accessors('simple' => qw/_source_handle/);
26 DBIx::Class::Row - Basic row methods
32 This class is responsible for defining and doing basic operations on rows
33 derived from L<DBIx::Class::ResultSource> objects.
35 Row objects are returned from L<DBIx::Class::ResultSet>s using the
36 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
37 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
38 as well as invocations of 'single' (
39 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
40 L<has_one|DBIx::Class::Relationship/has_one> or
41 L<might_have|DBIx::Class::Relationship/might_have>)
42 relationship accessors of L<DBIx::Class::Row> objects.
48 my $row = My::Class->new(\%attrs);
50 my $row = $schema->resultset('MySource')->new(\%colsandvalues);
54 =item Arguments: \%attrs or \%colsandvalues
56 =item Returns: A Row object
60 While you can create a new row object by calling C<new> directly on
61 this class, you are better off calling it on a
62 L<DBIx::Class::ResultSet> object.
64 When calling it directly, you will not get a complete, usable row
65 object until you pass or set the C<source_handle> attribute, to a
66 L<DBIx::Class::ResultSource> instance that is attached to a
67 L<DBIx::Class::Schema> with a valid connection.
69 C<$attrs> is a hashref of column name, value data. It can also contain
70 some other attributes such as the C<source_handle>.
72 Passing an object, or an arrayref of objects as a value will call
73 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
74 passed a hashref or an arrayref of hashrefs as the value, these will
75 be turned into objects via new_related, and treated as if you had
78 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
80 Please note that if a value is not passed to new, no value will be sent
81 in the SQL INSERT call, and the column will therefore assume whatever
82 default value was specified in your database. While DBIC will retrieve the
83 value of autoincrement columns, it will never make an explicit database
84 trip to retrieve default values assigned by the RDBMS. You can explicitly
85 request that all values be fetched back from the database by calling
86 L</discard_changes>, or you can supply an explicit C<undef> to columns
87 with NULL as the default, and save yourself a SELECT.
91 The behavior described above will backfire if you use a foreign key column
92 with a database-defined default. If you call the relationship accessor on
93 an object that doesn't have a set value for the FK column, DBIC will throw
94 an exception, as it has no way of knowing the PK of the related object (if
99 ## It needs to store the new objects somewhere, and call insert on that list later when insert is called on this object. We may need an accessor for these so the user can retrieve them, if just doing ->new().
100 ## This only works because DBIC doesnt yet care to check whether the new_related objects have been passed all their mandatory columns
101 ## When doing the later insert, we need to make sure the PKs are set.
102 ## using _relationship_data in new and funky ways..
103 ## check Relationship::CascadeActions and Relationship::Accessor for compat
106 sub __new_related_find_or_new_helper {
107 my ($self, $relname, $data) = @_;
109 # create a mock-object so all new/set_column component overrides will run:
110 my $rel_rs = $self->result_source
111 ->related_source($relname)
113 my $new_rel_obj = $rel_rs->new_result($data);
114 my $proc_data = { $new_rel_obj->get_columns };
116 if ($self->__their_pk_needs_us($relname)) {
117 MULTICREATE_DEBUG and warn "MC $self constructing $relname via new_result";
120 elsif ($self->result_source->_pk_depends_on($relname, $proc_data )) {
121 if (! keys %$proc_data) {
122 # there is nothing to search for - blind create
123 MULTICREATE_DEBUG and warn "MC $self constructing default-insert $relname";
126 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new";
127 # this is not *really* find or new, as we don't want to double-new the
128 # data (thus potentially double encoding or whatever)
129 my $exists = $rel_rs->find ($proc_data);
130 return $exists if $exists;
135 my $us = $self->source_name;
136 $self->throw_exception ("'$us' neither depends nor is depended on by '$relname', something is wrong...");
140 sub __their_pk_needs_us { # this should maybe be in resultsource.
141 my ($self, $relname) = @_;
142 my $source = $self->result_source;
143 my $reverse = $source->reverse_relationship_info($relname);
144 my $rel_source = $source->related_source($relname);
145 my $us = { $self->get_columns };
146 foreach my $key (keys %$reverse) {
147 # if their primary key depends on us, then we have to
148 # just create a result and we'll fill it out afterwards
149 return 1 if $rel_source->_pk_depends_on($key, $us);
155 my ($class, $attrs) = @_;
156 $class = ref $class if ref $class;
163 if (my $handle = delete $attrs->{-source_handle}) {
164 $new->_source_handle($handle);
168 if ($source = delete $attrs->{-result_source}) {
169 $new->result_source($source);
172 if (my $related = delete $attrs->{-cols_from_relations}) {
173 @{$new->{_ignore_at_insert}={}}{@$related} = ();
177 $new->throw_exception("attrs must be a hashref")
178 unless ref($attrs) eq 'HASH';
180 my ($related,$inflated);
182 foreach my $key (keys %$attrs) {
183 if (ref $attrs->{$key}) {
184 ## Can we extract this lot to use with update(_or .. ) ?
185 $new->throw_exception("Can't do multi-create without result source")
187 my $info = $source->relationship_info($key);
188 my $acc_type = $info->{attrs}{accessor} || '';
189 if ($acc_type eq 'single') {
190 my $rel_obj = delete $attrs->{$key};
191 if(!Scalar::Util::blessed($rel_obj)) {
192 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
195 if ($rel_obj->in_storage) {
196 $new->{_rel_in_storage}{$key} = 1;
197 $new->set_from_related($key, $rel_obj);
199 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj\n";
202 $related->{$key} = $rel_obj;
205 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
206 my $others = delete $attrs->{$key};
207 my $total = @$others;
209 foreach my $idx (0 .. $#$others) {
210 my $rel_obj = $others->[$idx];
211 if(!Scalar::Util::blessed($rel_obj)) {
212 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
215 if ($rel_obj->in_storage) {
216 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
218 MULTICREATE_DEBUG and
219 warn "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
221 push(@objects, $rel_obj);
223 $related->{$key} = \@objects;
226 elsif ($acc_type eq 'filter') {
227 ## 'filter' should disappear and get merged in with 'single' above!
228 my $rel_obj = delete $attrs->{$key};
229 if(!Scalar::Util::blessed($rel_obj)) {
230 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
232 if ($rel_obj->in_storage) {
233 $new->{_rel_in_storage}{$key} = 1;
236 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj";
238 $inflated->{$key} = $rel_obj;
240 } elsif ($class->has_column($key)
241 && $class->column_info($key)->{_inflate_info}) {
242 $inflated->{$key} = $attrs->{$key};
246 $new->throw_exception("No such column $key on $class")
247 unless $class->has_column($key);
248 $new->store_column($key => $attrs->{$key});
251 $new->{_relationship_data} = $related if $related;
252 $new->{_inflated_column} = $inflated if $inflated;
264 =item Arguments: none
266 =item Returns: The Row object
270 Inserts an object previously created by L</new> into the database if
271 it isn't already in there. Returns the object itself. Requires the
272 object's result source to be set, or the class to have a
273 result_source_instance method. To insert an entirely new row into
274 the database, use C<create> (see L<DBIx::Class::ResultSet/create>).
276 To fetch an uninserted row object, call
277 L<new|DBIx::Class::ResultSet/new> on a resultset.
279 This will also insert any uninserted, related objects held inside this
280 one, see L<DBIx::Class::ResultSet/create> for more details.
286 return $self if $self->in_storage;
287 my $source = $self->result_source;
288 $source ||= $self->result_source($self->result_source_instance)
289 if $self->can('result_source_instance');
290 $self->throw_exception("No result_source set on this object; can't insert")
295 # Check if we stored uninserted relobjs here in new()
296 my %related_stuff = (%{$self->{_relationship_data} || {}},
297 %{$self->{_inflated_column} || {}});
299 # insert what needs to be inserted before us
301 for my $relname (keys %related_stuff) {
302 my $rel_obj = $related_stuff{$relname};
304 if (! $self->{_rel_in_storage}{$relname}) {
305 next unless (Scalar::Util::blessed($rel_obj)
306 && $rel_obj->isa('DBIx::Class::Row'));
308 next unless $source->_pk_depends_on(
309 $relname, { $rel_obj->get_columns }
312 # The guard will save us if we blow out of this scope via die
313 $rollback_guard ||= $source->storage->txn_scope_guard;
315 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
317 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_inflated_columns };
320 # if there are no keys - nothing to search for
321 if (keys %$them and $existing = $self->result_source
322 ->related_source($relname)
326 %{$rel_obj} = %{$existing};
332 $self->{_rel_in_storage}{$relname} = 1;
335 $self->set_from_related($relname, $rel_obj);
336 delete $related_stuff{$relname};
339 # start a transaction here if not started yet and there is more stuff
341 if (keys %related_stuff) {
342 $rollback_guard ||= $source->storage->txn_scope_guard
345 MULTICREATE_DEBUG and do {
346 no warnings 'uninitialized';
347 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
349 my $updated_cols = $source->storage->insert($source, { $self->get_columns });
350 foreach my $col (keys %$updated_cols) {
351 $self->store_column($col, $updated_cols->{$col});
355 my @auto_pri = grep {
356 (not defined $self->get_column($_))
358 (ref($self->get_column($_)) eq 'SCALAR')
359 } $self->primary_columns;
362 MULTICREATE_DEBUG and warn "MC $self fetching missing PKs ".join(', ', @auto_pri)."\n";
363 my $storage = $self->result_source->storage;
364 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
365 unless $storage->can('last_insert_id');
366 my @ids = $storage->last_insert_id($self->result_source,@auto_pri);
367 $self->throw_exception( "Can't get last insert id" )
368 unless (@ids == @auto_pri);
369 $self->store_column($auto_pri[$_] => $ids[$_]) for 0 .. $#ids;
372 $self->{_dirty_columns} = {};
373 $self->{related_resultsets} = {};
375 foreach my $relname (keys %related_stuff) {
376 next unless $source->has_relationship ($relname);
378 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
379 ? @{$related_stuff{$relname}}
380 : $related_stuff{$relname}
384 && Scalar::Util::blessed($cands[0])
385 && $cands[0]->isa('DBIx::Class::Row')
387 my $reverse = $source->reverse_relationship_info($relname);
388 foreach my $obj (@cands) {
389 $obj->set_from_related($_, $self) for keys %$reverse;
390 my $them = { %{$obj->{_relationship_data} || {} }, $obj->get_inflated_columns };
391 if ($self->__their_pk_needs_us($relname)) {
392 if (exists $self->{_ignore_at_insert}{$relname}) {
393 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
395 MULTICREATE_DEBUG and warn "MC $self re-creating $relname $obj";
396 my $re = $self->result_source
397 ->related_source($relname)
401 MULTICREATE_DEBUG and warn "MC $self new $relname $obj";
404 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
411 $self->in_storage(1);
412 delete $self->{_orig_ident};
413 delete $self->{_ignore_at_insert};
414 $rollback_guard->commit if $rollback_guard;
421 $row->in_storage; # Get value
422 $row->in_storage(1); # Set value
426 =item Arguments: none or 1|0
432 Indicates whether the object exists as a row in the database or
433 not. This is set to true when L<DBIx::Class::ResultSet/find>,
434 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
437 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
438 L</delete> on one, sets it to false.
443 my ($self, $val) = @_;
444 $self->{_in_storage} = $val if @_ > 1;
445 return $self->{_in_storage} ? 1 : 0;
450 $row->update(\%columns?)
454 =item Arguments: none or a hashref
456 =item Returns: The Row object
460 Throws an exception if the row object is not yet in the database,
461 according to L</in_storage>.
463 This method issues an SQL UPDATE query to commit any changes to the
464 object to the database if required (see L</get_dirty_columns>).
465 It throws an exception if a proper WHERE clause uniquely identifying
466 the database row can not be constructed (see
467 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
470 Also takes an optional hashref of C<< column_name => value> >> pairs
471 to update on the object first. Be aware that the hashref will be
472 passed to C<set_inflated_columns>, which might edit it in place, so
473 don't rely on it being the same after a call to C<update>. If you
474 need to preserve the hashref, it is sufficient to pass a shallow copy
475 to C<update>, e.g. ( { %{ $href } } )
477 If the values passed or any of the column values set on the object
478 contain scalar references, e.g.:
480 $row->last_modified(\'NOW()');
482 $row->update({ last_modified => \'NOW()' });
484 The update will pass the values verbatim into SQL. (See
485 L<SQL::Abstract> docs). The values in your Row object will NOT change
486 as a result of the update call, if you want the object to be updated
487 with the actual values from the database, call L</discard_changes>
490 $row->update()->discard_changes();
492 To determine before calling this method, which column values have
493 changed and will be updated, call L</get_dirty_columns>.
495 To check if any columns will be updated, call L</is_changed>.
497 To force a column to be updated, call L</make_column_dirty> before
503 my ($self, $upd) = @_;
504 $self->throw_exception( "Not in database" ) unless $self->in_storage;
506 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
508 $self->throw_exception('Unable to update a row with incomplete or no identity')
509 if ! keys %$ident_cond;
511 $self->set_inflated_columns($upd) if $upd;
512 my %to_update = $self->get_dirty_columns;
513 return $self unless keys %to_update;
514 my $rows = $self->result_source->storage->update(
515 $self->result_source, \%to_update, $ident_cond
518 $self->throw_exception( "Can't update ${self}: row not found" );
519 } elsif ($rows > 1) {
520 $self->throw_exception("Can't update ${self}: updated more than one row");
522 $self->{_dirty_columns} = {};
523 $self->{related_resultsets} = {};
524 delete $self->{_orig_ident};
534 =item Arguments: none
536 =item Returns: The Row object
540 Throws an exception if the object is not in the database according to
541 L</in_storage>. Also throws an exception if a proper WHERE clause
542 uniquely identifying the database row can not be constructed (see
543 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
546 The object is still perfectly usable, but L</in_storage> will
547 now return 0 and the object must be reinserted using L</insert>
548 before it can be used to L</update> the row again.
550 If you delete an object in a class with a C<has_many> relationship, an
551 attempt is made to delete all the related objects as well. To turn
552 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
553 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
554 database-level cascade or restrict will take precedence over a
555 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
556 main row first> and only then attempts to delete any remaining related
559 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
560 and the transaction subsequently fails, the row object will remain marked as
561 not being in storage. If you know for a fact that the object is still in
562 storage (i.e. by inspecting the cause of the transaction's failure), you can
563 use C<< $obj->in_storage(1) >> to restore consistency between the object and
564 the database. This would allow a subsequent C<< $obj->delete >> to work
567 See also L<DBIx::Class::ResultSet/delete>.
574 $self->throw_exception( "Not in database" ) unless $self->in_storage;
576 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
577 $self->throw_exception('Unable to delete a row with incomplete or no identity')
578 if ! keys %$ident_cond;
580 $self->result_source->storage->delete(
581 $self->result_source, $ident_cond
584 delete $self->{_orig_ident};
585 $self->in_storage(undef);
588 $self->throw_exception("Can't do class delete without a ResultSource instance")
589 unless $self->can('result_source_instance');
590 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
591 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
592 $self->result_source_instance->resultset->search(@_)->delete;
599 my $val = $row->get_column($col);
603 =item Arguments: $columnname
605 =item Returns: The value of the column
609 Throws an exception if the column name given doesn't exist according
612 Returns a raw column value from the row object, if it has already
613 been fetched from the database or set by an accessor.
615 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
616 will be deflated and returned.
618 Note that if you used the C<columns> or the C<select/as>
619 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
620 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
621 this method will return C<undef> even if the database contains some value.
623 To retrieve all loaded column values as a hash, use L</get_columns>.
628 my ($self, $column) = @_;
629 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
630 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
631 if (exists $self->{_inflated_column}{$column}) {
632 return $self->store_column($column,
633 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
635 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
639 =head2 has_column_loaded
641 if ( $row->has_column_loaded($col) ) {
642 print "$col has been loaded from db";
647 =item Arguments: $columnname
653 Returns a true value if the column value has been loaded from the
654 database (or set locally).
658 sub has_column_loaded {
659 my ($self, $column) = @_;
660 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
661 return 1 if exists $self->{_inflated_column}{$column};
662 return exists $self->{_column_data}{$column};
667 my %data = $row->get_columns;
671 =item Arguments: none
673 =item Returns: A hash of columnname, value pairs.
677 Returns all loaded column data as a hash, containing raw values. To
678 get just one value for a particular column, use L</get_column>.
680 See L</get_inflated_columns> to get the inflated values.
686 if (exists $self->{_inflated_column}) {
687 foreach my $col (keys %{$self->{_inflated_column}}) {
688 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
689 unless exists $self->{_column_data}{$col};
692 return %{$self->{_column_data}};
695 =head2 get_dirty_columns
697 my %data = $row->get_dirty_columns;
701 =item Arguments: none
703 =item Returns: A hash of column, value pairs
707 Only returns the column, value pairs for those columns that have been
708 changed on this object since the last L</update> or L</insert> call.
710 See L</get_columns> to fetch all column/value pairs.
714 sub get_dirty_columns {
716 return map { $_ => $self->{_column_data}{$_} }
717 keys %{$self->{_dirty_columns}};
720 =head2 make_column_dirty
722 $row->make_column_dirty($col)
726 =item Arguments: $columnname
728 =item Returns: undefined
732 Throws an exception if the column does not exist.
734 Marks a column as having been changed regardless of whether it has
738 sub make_column_dirty {
739 my ($self, $column) = @_;
741 $self->throw_exception( "No such column '${column}'" )
742 unless exists $self->{_column_data}{$column} || $self->has_column($column);
744 # the entire clean/dirty code relies on exists, not on true/false
745 return 1 if exists $self->{_dirty_columns}{$column};
747 $self->{_dirty_columns}{$column} = 1;
749 # if we are just now making the column dirty, and if there is an inflated
750 # value, force it over the deflated one
751 if (exists $self->{_inflated_column}{$column}) {
752 $self->store_column($column,
753 $self->_deflated_column(
754 $column, $self->{_inflated_column}{$column}
760 =head2 get_inflated_columns
762 my %inflated_data = $obj->get_inflated_columns;
766 =item Arguments: none
768 =item Returns: A hash of column, object|value pairs
772 Returns a hash of all column keys and associated values. Values for any
773 columns set to use inflation will be inflated and returns as objects.
775 See L</get_columns> to get the uninflated values.
777 See L<DBIx::Class::InflateColumn> for how to setup inflation.
781 sub get_inflated_columns {
784 my %loaded_colinfo = (map
785 { $_ => $self->column_info($_) }
786 (grep { $self->has_column_loaded($_) } $self->columns)
790 for my $col (keys %loaded_colinfo) {
791 if (exists $loaded_colinfo{$col}{accessor}) {
792 my $acc = $loaded_colinfo{$col}{accessor};
793 $inflated{$col} = $self->$acc if defined $acc;
796 $inflated{$col} = $self->$col;
800 # return all loaded columns with the inflations overlayed on top
801 return ($self->get_columns, %inflated);
804 sub _is_column_numeric {
805 my ($self, $column) = @_;
806 my $colinfo = $self->column_info ($column);
808 # cache for speed (the object may *not* have a resultsource instance)
809 if (not defined $colinfo->{is_numeric} && $self->_source_handle) {
810 $colinfo->{is_numeric} =
811 $self->result_source->schema->storage->is_datatype_numeric ($colinfo->{data_type})
817 return $colinfo->{is_numeric};
822 $row->set_column($col => $val);
826 =item Arguments: $columnname, $value
828 =item Returns: $value
832 Sets a raw column value. If the new value is different from the old one,
833 the column is marked as dirty for when you next call L</update>.
835 If passed an object or reference as a value, this method will happily
836 attempt to store it, and a later L</insert> or L</update> will try and
837 stringify/numify as appropriate. To set an object to be deflated
838 instead, see L</set_inflated_columns>.
843 my ($self, $column, $new_value) = @_;
845 # if we can't get an ident condition on first try - mark the object as unidentifiable
846 $self->{_orig_ident} ||= (eval { $self->ident_condition }) || {};
848 my $old_value = $self->get_column($column);
849 $new_value = $self->store_column($column, $new_value);
852 if (!$self->in_storage) { # no point tracking dirtyness on uninserted data
855 elsif (defined $old_value xor defined $new_value) {
858 elsif (not defined $old_value) { # both undef
861 elsif ($old_value eq $new_value) {
864 else { # do a numeric comparison if datatype allows it
865 if ($self->_is_column_numeric($column)) {
866 $dirty = $old_value != $new_value;
873 # sadly the update code just checks for keys, not for their value
874 $self->{_dirty_columns}{$column} = 1 if $dirty;
876 # XXX clear out the relation cache for this column
877 delete $self->{related_resultsets}{$column};
884 $row->set_columns({ $col => $val, ... });
888 =item Arguments: \%columndata
890 =item Returns: The Row object
894 Sets multiple column, raw value pairs at once.
896 Works as L</set_column>.
901 my ($self,$data) = @_;
902 foreach my $col (keys %$data) {
903 $self->set_column($col,$data->{$col});
908 =head2 set_inflated_columns
910 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
914 =item Arguments: \%columndata
916 =item Returns: The Row object
920 Sets more than one column value at once. Any inflated values are
921 deflated and the raw values stored.
923 Any related values passed as Row objects, using the relation name as a
924 key, are reduced to the appropriate foreign key values and stored. If
925 instead of related row objects, a hashref of column, value data is
926 passed, will create the related object first then store.
928 Will even accept arrayrefs of data as a value to a
929 L<DBIx::Class::Relationship/has_many> key, and create the related
930 objects if necessary.
932 Be aware that the input hashref might be edited in place, so don't rely
933 on it being the same after a call to C<set_inflated_columns>. If you
934 need to preserve the hashref, it is sufficient to pass a shallow copy
935 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
937 See also L<DBIx::Class::Relationship::Base/set_from_related>.
941 sub set_inflated_columns {
942 my ( $self, $upd ) = @_;
943 foreach my $key (keys %$upd) {
944 if (ref $upd->{$key}) {
945 my $info = $self->relationship_info($key);
946 my $acc_type = $info->{attrs}{accessor} || '';
947 if ($acc_type eq 'single') {
948 my $rel = delete $upd->{$key};
949 $self->set_from_related($key => $rel);
950 $self->{_relationship_data}{$key} = $rel;
952 elsif ($acc_type eq 'multi') {
953 $self->throw_exception(
954 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
957 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
958 $self->set_inflated_column($key, delete $upd->{$key});
962 $self->set_columns($upd);
967 my $copy = $orig->copy({ change => $to, ... });
971 =item Arguments: \%replacementdata
973 =item Returns: The Row object copy
977 Inserts a new row into the database, as a copy of the original
978 object. If a hashref of replacement data is supplied, these will take
979 precedence over data in the original. Also any columns which have
980 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
981 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
982 so that the database can insert its own autoincremented values into
985 Relationships will be followed by the copy procedure B<only> if the
986 relationship specifies a true value for its
987 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
988 is set by default on C<has_many> relationships and unset on all others.
993 my ($self, $changes) = @_;
995 my $col_data = { %{$self->{_column_data}} };
996 foreach my $col (keys %$col_data) {
997 delete $col_data->{$col}
998 if $self->result_source->column_info($col)->{is_auto_increment};
1001 my $new = { _column_data => $col_data };
1002 bless $new, ref $self;
1004 $new->result_source($self->result_source);
1005 $new->set_inflated_columns($changes);
1008 # Its possible we'll have 2 relations to the same Source. We need to make
1009 # sure we don't try to insert the same row twice else we'll violate unique
1011 my $rels_copied = {};
1013 foreach my $rel ($self->result_source->relationships) {
1014 my $rel_info = $self->result_source->relationship_info($rel);
1016 next unless $rel_info->{attrs}{cascade_copy};
1018 my $resolved = $self->result_source->_resolve_condition(
1019 $rel_info->{cond}, $rel, $new
1022 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1023 foreach my $related ($self->search_related($rel)) {
1024 my $id_str = join("\0", $related->id);
1025 next if $copied->{$id_str};
1026 $copied->{$id_str} = 1;
1027 my $rel_copy = $related->copy($resolved);
1036 $row->store_column($col => $val);
1040 =item Arguments: $columnname, $value
1042 =item Returns: The value sent to storage
1046 Set a raw value for a column without marking it as changed. This
1047 method is used internally by L</set_column> which you should probably
1050 This is the lowest level at which data is set on a row object,
1051 extend this method to catch all data setting methods.
1056 my ($self, $column, $value) = @_;
1057 $self->throw_exception( "No such column '${column}'" )
1058 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1059 $self->throw_exception( "set_column called for ${column} without value" )
1061 return $self->{_column_data}{$column} = $value;
1064 =head2 inflate_result
1066 Class->inflate_result($result_source, \%me, \%prefetch?)
1070 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1072 =item Returns: A Row object
1076 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1077 database and turn it into row objects call this method.
1079 Extend this method in your Result classes to hook into this process,
1080 for example to rebless the result into a different class.
1082 Reblessing can also be done more easily by setting C<result_class> in
1083 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1085 Different types of results can also be created from a particular
1086 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1090 sub inflate_result {
1091 my ($class, $source, $me, $prefetch) = @_;
1093 my ($source_handle) = $source;
1095 if ($source->isa('DBIx::Class::ResultSourceHandle')) {
1096 $source = $source_handle->resolve
1099 $source_handle = $source->handle
1103 _source_handle => $source_handle,
1104 _column_data => $me,
1106 bless $new, (ref $class || $class);
1108 foreach my $pre (keys %{$prefetch||{}}) {
1110 my $pre_source = $source->related_source($pre)
1111 or $class->throw_exception("Can't prefetch non-existent relationship ${pre}");
1113 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1114 or $class->throw_exception("No accessor for prefetched $pre");
1117 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1118 @pre_vals = @{$prefetch->{$pre}};
1120 elsif ($accessor eq 'multi') {
1121 $class->throw_exception("Implicit prefetch (via select/columns) not supported with accessor 'multi'");
1124 @pre_vals = $prefetch->{$pre};
1128 for my $me_pref (@pre_vals) {
1130 # FIXME - this should not be necessary
1131 # the collapser currently *could* return bogus elements with all
1132 # columns set to undef
1134 for (values %{$me_pref->[0]}) {
1140 next unless $has_def;
1142 push @pre_objects, $pre_source->result_class->inflate_result(
1143 $pre_source, @$me_pref
1147 if ($accessor eq 'single') {
1148 $new->{_relationship_data}{$pre} = $pre_objects[0];
1150 elsif ($accessor eq 'filter') {
1151 $new->{_inflated_column}{$pre} = $pre_objects[0];
1154 $new->related_resultset($pre)->set_cache(\@pre_objects);
1157 $new->in_storage (1);
1161 =head2 update_or_insert
1163 $row->update_or_insert
1167 =item Arguments: none
1169 =item Returns: Result of update or insert operation
1173 L</Update>s the object if it's already in the database, according to
1174 L</in_storage>, else L</insert>s it.
1176 =head2 insert_or_update
1178 $obj->insert_or_update
1180 Alias for L</update_or_insert>
1184 sub insert_or_update { shift->update_or_insert(@_) }
1186 sub update_or_insert {
1188 return ($self->in_storage ? $self->update : $self->insert);
1193 my @changed_col_names = $row->is_changed();
1194 if ($row->is_changed()) { ... }
1198 =item Arguments: none
1200 =item Returns: 0|1 or @columnnames
1204 In list context returns a list of columns with uncommited changes, or
1205 in scalar context returns a true value if there are uncommitted
1211 return keys %{shift->{_dirty_columns} || {}};
1214 =head2 is_column_changed
1216 if ($row->is_column_changed('col')) { ... }
1220 =item Arguments: $columname
1226 Returns a true value if the column has uncommitted changes.
1230 sub is_column_changed {
1231 my( $self, $col ) = @_;
1232 return exists $self->{_dirty_columns}->{$col};
1235 =head2 result_source
1237 my $resultsource = $row->result_source;
1241 =item Arguments: none
1243 =item Returns: a ResultSource instance
1247 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1255 $self->_source_handle($_[0]->handle);
1257 $self->_source_handle->resolve;
1261 =head2 register_column
1263 $column_info = { .... };
1264 $class->register_column($column_name, $column_info);
1268 =item Arguments: $columnname, \%columninfo
1270 =item Returns: undefined
1274 Registers a column on the class. If the column_info has an 'accessor'
1275 key, creates an accessor named after the value if defined; if there is
1276 no such key, creates an accessor with the same name as the column
1278 The column_info attributes are described in
1279 L<DBIx::Class::ResultSource/add_columns>
1283 sub register_column {
1284 my ($class, $col, $info) = @_;
1286 if (exists $info->{accessor}) {
1287 return unless defined $info->{accessor};
1288 $acc = [ $info->{accessor}, $col ];
1290 $class->mk_group_accessors('column' => $acc);
1293 =head2 get_from_storage
1295 my $copy = $row->get_from_storage($attrs)
1299 =item Arguments: \%attrs
1301 =item Returns: A Row object
1305 Fetches a fresh copy of the Row object from the database and returns it.
1306 Throws an exception if a proper WHERE clause identifying the database row
1307 can not be constructed (i.e. if the original object does not contain its
1309 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1310 ). If passed the \%attrs argument, will first apply these attributes to
1311 the resultset used to find the row.
1313 This copy can then be used to compare to an existing row object, to
1314 determine if any changes have been made in the database since it was
1317 To just update your Row object with any latest changes from the
1318 database, use L</discard_changes> instead.
1320 The \%attrs argument should be compatible with
1321 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1325 sub get_from_storage {
1326 my $self = shift @_;
1327 my $attrs = shift @_;
1328 my $resultset = $self->result_source->resultset;
1330 if(defined $attrs) {
1331 $resultset = $resultset->search(undef, $attrs);
1334 my $ident_cond = $self->{_orig_ident} || $self->ident_condition;
1336 $self->throw_exception('Unable to requery a row with incomplete or no identity')
1337 if ! keys %$ident_cond;
1339 return $resultset->find($ident_cond);
1342 =head2 discard_changes ($attrs)
1344 Re-selects the row from the database, losing any changes that had
1345 been made. Throws an exception if a proper WHERE clause identifying
1346 the database row can not be constructed (i.e. if the original object
1347 does not contain its entire
1348 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1351 This method can also be used to refresh from storage, retrieving any
1352 changes made since the row was last read from storage.
1354 $attrs is expected to be a hashref of attributes suitable for passing as the
1355 second argument to $resultset->search($cond, $attrs);
1359 sub discard_changes {
1360 my ($self, $attrs) = @_;
1361 delete $self->{_dirty_columns};
1362 return unless $self->in_storage; # Don't reload if we aren't real!
1364 # add a replication default to read from the master only
1365 $attrs = { force_pool => 'master', %{$attrs||{}} };
1367 if( my $current_storage = $self->get_from_storage($attrs)) {
1369 # Set $self to the current.
1370 %$self = %$current_storage;
1372 # Avoid a possible infinite loop with
1373 # sub DESTROY { $_[0]->discard_changes }
1374 bless $current_storage, 'Do::Not::Exist';
1379 $self->in_storage(0);
1385 =head2 throw_exception
1387 See L<DBIx::Class::Schema/throw_exception>.
1391 sub throw_exception {
1394 if (ref $self && ref $self->result_source && $self->result_source->schema) {
1395 $self->result_source->schema->throw_exception(@_)
1398 DBIx::Class::Exception->throw(@_);
1408 =item Arguments: none
1410 =item Returns: A list of primary key values
1414 Returns the primary key(s) for a row. Can't be called as a class method.
1415 Actually implemented in L<DBIx::Class::PK>
1417 =head2 discard_changes
1419 $row->discard_changes
1423 =item Arguments: none
1425 =item Returns: nothing (updates object in-place)
1429 Retrieves and sets the row object data from the database, losing any
1432 This method can also be used to refresh from storage, retrieving any
1433 changes made since the row was last read from storage. Actually
1434 implemented in L<DBIx::Class::PK>
1436 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1437 storage, please kept in mind that if you L</discard_changes> on a row that you
1438 just updated or created, you should wrap the entire bit inside a transaction.
1439 Otherwise you run the risk that you insert or update to the master database
1440 but read from a replicant database that has not yet been updated from the
1441 master. This will result in unexpected results.
1449 Matt S. Trout <mst@shadowcatsystems.co.uk>
1453 You may distribute this code under the same terms as Perl itself.