1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
8 use Scalar::Util 'blessed';
9 use List::Util 'first';
18 $ENV{DBIC_MULTICREATE_DEBUG}
25 __PACKAGE__->mk_group_accessors ( simple => [ in_storage => '_in_storage' ] );
29 DBIx::Class::Row - Basic row methods
35 This class is responsible for defining and doing basic operations on rows
36 derived from L<DBIx::Class::ResultSource> objects.
38 Result objects are returned from L<DBIx::Class::ResultSet>s using the
39 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
40 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
41 as well as invocations of 'single' (
42 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
43 L<has_one|DBIx::Class::Relationship/has_one> or
44 L<might_have|DBIx::Class::Relationship/might_have>)
45 relationship accessors of L<Result|DBIx::Class::Manual::ResultClass> objects.
49 All "Row objects" derived from a Schema-attached L<DBIx::Class::ResultSet>
50 object (such as a typical C<< L<search|DBIx::Class::ResultSet/search
51 >->L<next|DBIx::Class::ResultSet/next> >> call) are actually Result
52 instances, based on your application's
53 L<Result class|DBIx::Class::Manual::Glossary/Result_class>.
55 L<DBIx::Class::Row> implements most of the row-based communication with the
56 underlying storage, but a Result class B<should not inherit from it directly>.
57 Usually, Result classes inherit from L<DBIx::Class::Core>, which in turn
58 combines the methods from several classes, one of them being
59 L<DBIx::Class::Row>. Therefore, while many of the methods available to a
60 L<DBIx::Class::Core>-derived Result class are described in the following
61 documentation, it does not detail all of the methods available to Result
62 objects. Refer to L<DBIx::Class::Manual::ResultClass> for more info.
68 my $row = My::Class->new(\%attrs);
70 my $row = $schema->resultset('MySource')->new(\%colsandvalues);
74 =item Arguments: \%attrs or \%colsandvalues
76 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
80 While you can create a new result object by calling C<new> directly on
81 this class, you are better off calling it on a
82 L<DBIx::Class::ResultSet> object.
84 When calling it directly, you will not get a complete, usable row
85 object until you pass or set the C<result_source> attribute, to a
86 L<DBIx::Class::ResultSource> instance that is attached to a
87 L<DBIx::Class::Schema> with a valid connection.
89 C<$attrs> is a hashref of column name, value data. It can also contain
90 some other attributes such as the C<result_source>.
92 Passing an object, or an arrayref of objects as a value will call
93 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
94 passed a hashref or an arrayref of hashrefs as the value, these will
95 be turned into objects via new_related, and treated as if you had
98 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
100 Please note that if a value is not passed to new, no value will be sent
101 in the SQL INSERT call, and the column will therefore assume whatever
102 default value was specified in your database. While DBIC will retrieve the
103 value of autoincrement columns, it will never make an explicit database
104 trip to retrieve default values assigned by the RDBMS. You can explicitly
105 request that all values be fetched back from the database by calling
106 L</discard_changes>, or you can supply an explicit C<undef> to columns
107 with NULL as the default, and save yourself a SELECT.
111 The behavior described above will backfire if you use a foreign key column
112 with a database-defined default. If you call the relationship accessor on
113 an object that doesn't have a set value for the FK column, DBIC will throw
114 an exception, as it has no way of knowing the PK of the related object (if
119 ## 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().
120 ## This only works because DBIC doesnt yet care to check whether the new_related objects have been passed all their mandatory columns
121 ## When doing the later insert, we need to make sure the PKs are set.
122 ## using _relationship_data in new and funky ways..
123 ## check Relationship::CascadeActions and Relationship::Accessor for compat
126 sub __new_related_find_or_new_helper {
127 my ($self, $relname, $data) = @_;
129 my $rsrc = $self->result_source;
131 # create a mock-object so all new/set_column component overrides will run:
132 my $rel_rs = $rsrc->related_source($relname)->resultset;
133 my $new_rel_obj = $rel_rs->new_result($data);
134 my $proc_data = { $new_rel_obj->get_columns };
136 if ($self->__their_pk_needs_us($relname)) {
137 MULTICREATE_DEBUG and warn "MC $self constructing $relname via new_result";
140 elsif ($rsrc->_pk_depends_on($relname, $proc_data )) {
141 if (! keys %$proc_data) {
142 # there is nothing to search for - blind create
143 MULTICREATE_DEBUG and warn "MC $self constructing default-insert $relname";
146 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new";
147 # this is not *really* find or new, as we don't want to double-new the
148 # data (thus potentially double encoding or whatever)
149 my $exists = $rel_rs->find ($proc_data);
150 return $exists if $exists;
155 my $us = $rsrc->source_name;
156 $self->throw_exception (
157 "Unable to determine relationship '$relname' direction from '$us', "
158 . "possibly due to a missing reverse-relationship on '$relname' to '$us'."
163 sub __their_pk_needs_us { # this should maybe be in resultsource.
164 my ($self, $relname) = @_;
165 my $source = $self->result_source;
166 my $reverse = $source->reverse_relationship_info($relname);
167 my $rel_source = $source->related_source($relname);
168 my $us = { $self->get_columns };
169 foreach my $key (keys %$reverse) {
170 # if their primary key depends on us, then we have to
171 # just create a result and we'll fill it out afterwards
172 return 1 if $rel_source->_pk_depends_on($key, $us);
178 my ($class, $attrs) = @_;
179 $class = ref $class if ref $class;
181 my $new = bless { _column_data => {}, _in_storage => 0 }, $class;
184 $new->throw_exception("attrs must be a hashref")
185 unless ref($attrs) eq 'HASH';
187 my $source = delete $attrs->{-result_source};
188 if ( my $h = delete $attrs->{-source_handle} ) {
189 $source ||= $h->resolve;
192 $new->result_source($source) if $source;
194 if (my $col_from_rel = delete $attrs->{-cols_from_relations}) {
195 @{$new->{_ignore_at_insert}={}}{@$col_from_rel} = ();
198 my ($related,$inflated);
200 foreach my $key (keys %$attrs) {
201 if (ref $attrs->{$key}) {
202 ## Can we extract this lot to use with update(_or .. ) ?
203 $new->throw_exception("Can't do multi-create without result source")
205 my $info = $source->relationship_info($key);
206 my $acc_type = $info->{attrs}{accessor} || '';
207 if ($acc_type eq 'single') {
208 my $rel_obj = delete $attrs->{$key};
209 if(!blessed $rel_obj) {
210 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
213 if ($rel_obj->in_storage) {
214 $new->{_rel_in_storage}{$key} = 1;
215 $new->set_from_related($key, $rel_obj);
217 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj\n";
220 $related->{$key} = $rel_obj;
223 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
224 my $others = delete $attrs->{$key};
225 my $total = @$others;
227 foreach my $idx (0 .. $#$others) {
228 my $rel_obj = $others->[$idx];
229 if(!blessed $rel_obj) {
230 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
233 if ($rel_obj->in_storage) {
234 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
236 MULTICREATE_DEBUG and
237 warn "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
239 push(@objects, $rel_obj);
241 $related->{$key} = \@objects;
244 elsif ($acc_type eq 'filter') {
245 ## 'filter' should disappear and get merged in with 'single' above!
246 my $rel_obj = delete $attrs->{$key};
247 if(!blessed $rel_obj) {
248 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
250 if ($rel_obj->in_storage) {
251 $new->{_rel_in_storage}{$key} = 1;
254 MULTICREATE_DEBUG and warn "MC $new uninserted $key $rel_obj";
256 $inflated->{$key} = $rel_obj;
258 } elsif ($class->has_column($key)
259 && $class->column_info($key)->{_inflate_info}) {
260 $inflated->{$key} = $attrs->{$key};
264 $new->throw_exception("No such column '$key' on $class")
265 unless $class->has_column($key);
266 $new->store_column($key => $attrs->{$key});
269 $new->{_relationship_data} = $related if $related;
270 $new->{_inflated_column} = $inflated if $inflated;
276 =head2 $column_accessor
278 # Each pair does the same thing
280 # (un-inflated, regular column)
281 my $val = $row->get_column('first_name');
282 my $val = $row->first_name;
284 $row->set_column('first_name' => $val);
285 $row->first_name($val);
287 # (inflated column via DBIx::Class::InflateColumn::DateTime)
288 my $val = $row->get_inflated_column('last_modified');
289 my $val = $row->last_modified;
291 $row->set_inflated_column('last_modified' => $val);
292 $row->last_modified($val);
296 =item Arguments: $value?
298 =item Return Value: $value
302 A column accessor method is created for each column, which is used for
303 getting/setting the value for that column.
305 The actual method name is based on the
306 L<accessor|DBIx::Class::ResultSource/accessor> name given during the
307 L<Result Class|DBIx::Class::Manual::ResultClass> L<column definition
308 |DBIx::Class::ResultSource/add_columns>. Like L</set_column>, this
309 will not store the data in the database until L</insert> or L</update>
310 is called on the row.
318 =item Arguments: none
320 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
324 Inserts an object previously created by L</new> into the database if
325 it isn't already in there. Returns the object itself. To insert an
326 entirely new row into the database, use L<DBIx::Class::ResultSet/create>.
328 To fetch an uninserted result object, call
329 L<new_result|DBIx::Class::ResultSet/new_result> on a resultset.
331 This will also insert any uninserted, related objects held inside this
332 one, see L<DBIx::Class::ResultSet/create> for more details.
338 return $self if $self->in_storage;
339 my $source = $self->result_source;
340 $self->throw_exception("No result_source set on this object; can't insert")
343 my $storage = $source->storage;
347 # Check if we stored uninserted relobjs here in new()
348 my %related_stuff = (%{$self->{_relationship_data} || {}},
349 %{$self->{_inflated_column} || {}});
351 # insert what needs to be inserted before us
353 for my $relname (keys %related_stuff) {
354 my $rel_obj = $related_stuff{$relname};
356 if (! $self->{_rel_in_storage}{$relname}) {
357 next unless (blessed $rel_obj && $rel_obj->isa('DBIx::Class::Row'));
359 next unless $source->_pk_depends_on(
360 $relname, { $rel_obj->get_columns }
363 # The guard will save us if we blow out of this scope via die
364 $rollback_guard ||= $storage->txn_scope_guard;
366 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
368 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_columns };
371 # if there are no keys - nothing to search for
372 if (keys %$them and $existing = $self->result_source
373 ->related_source($relname)
377 %{$rel_obj} = %{$existing};
383 $self->{_rel_in_storage}{$relname} = 1;
386 $self->set_from_related($relname, $rel_obj);
387 delete $related_stuff{$relname};
390 # start a transaction here if not started yet and there is more stuff
392 if (keys %related_stuff) {
393 $rollback_guard ||= $storage->txn_scope_guard
396 MULTICREATE_DEBUG and do {
397 no warnings 'uninitialized';
398 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
401 # perform the insert - the storage will return everything it is asked to
402 # (autoinc primary columns and any retrieve_on_insert columns)
403 my %current_rowdata = $self->get_columns;
404 my $returned_cols = $storage->insert(
406 { %current_rowdata }, # what to insert, copy because the storage *will* change it
409 for (keys %$returned_cols) {
410 $self->store_column($_, $returned_cols->{$_})
411 # this ensures we fire store_column only once
412 # (some asshats like overriding it)
414 (!exists $current_rowdata{$_})
416 (defined $current_rowdata{$_} xor defined $returned_cols->{$_})
418 (defined $current_rowdata{$_} and $current_rowdata{$_} ne $returned_cols->{$_})
422 delete $self->{_column_data_in_storage};
423 $self->in_storage(1);
425 $self->{_dirty_columns} = {};
426 $self->{related_resultsets} = {};
428 foreach my $relname (keys %related_stuff) {
429 next unless $source->has_relationship ($relname);
431 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
432 ? @{$related_stuff{$relname}}
433 : $related_stuff{$relname}
436 if (@cands && blessed $cands[0] && $cands[0]->isa('DBIx::Class::Row')
438 my $reverse = $source->reverse_relationship_info($relname);
439 foreach my $obj (@cands) {
440 $obj->set_from_related($_, $self) for keys %$reverse;
441 if ($self->__their_pk_needs_us($relname)) {
442 if (exists $self->{_ignore_at_insert}{$relname}) {
443 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
446 MULTICREATE_DEBUG and warn "MC $self inserting $relname $obj";
450 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
457 delete $self->{_ignore_at_insert};
459 $rollback_guard->commit if $rollback_guard;
466 $row->in_storage; # Get value
467 $row->in_storage(1); # Set value
471 =item Arguments: none or 1|0
473 =item Return Value: 1|0
477 Indicates whether the object exists as a row in the database or
478 not. This is set to true when L<DBIx::Class::ResultSet/find>,
479 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
482 Creating a result object using L<DBIx::Class::ResultSet/new_result>, or
483 calling L</delete> on one, sets it to false.
488 $row->update(\%columns?)
492 =item Arguments: none or a hashref
494 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
498 Throws an exception if the result object is not yet in the database,
499 according to L</in_storage>.
501 This method issues an SQL UPDATE query to commit any changes to the
502 object to the database if required (see L</get_dirty_columns>).
503 It throws an exception if a proper WHERE clause uniquely identifying
504 the database row can not be constructed (see
505 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
508 Also takes an optional hashref of C<< column_name => value >> pairs
509 to update on the object first. Be aware that the hashref will be
510 passed to C<set_inflated_columns>, which might edit it in place, so
511 don't rely on it being the same after a call to C<update>. If you
512 need to preserve the hashref, it is sufficient to pass a shallow copy
513 to C<update>, e.g. ( { %{ $href } } )
515 If the values passed or any of the column values set on the object
516 contain scalar references, e.g.:
518 $row->last_modified(\'NOW()')->update();
520 $row->update({ last_modified => \'NOW()' });
522 The update will pass the values verbatim into SQL. (See
523 L<SQL::Abstract> docs). The values in your Result object will NOT change
524 as a result of the update call, if you want the object to be updated
525 with the actual values from the database, call L</discard_changes>
528 $row->update()->discard_changes();
530 To determine before calling this method, which column values have
531 changed and will be updated, call L</get_dirty_columns>.
533 To check if any columns will be updated, call L</is_changed>.
535 To force a column to be updated, call L</make_column_dirty> before
541 my ($self, $upd) = @_;
543 $self->set_inflated_columns($upd) if $upd;
545 my %to_update = $self->get_dirty_columns
548 $self->throw_exception( "Not in database" ) unless $self->in_storage;
550 my $rows = $self->result_source->storage->update(
551 $self->result_source, \%to_update, $self->_storage_ident_condition
554 $self->throw_exception( "Can't update ${self}: row not found" );
555 } elsif ($rows > 1) {
556 $self->throw_exception("Can't update ${self}: updated more than one row");
558 $self->{_dirty_columns} = {};
559 $self->{related_resultsets} = {};
560 delete $self->{_column_data_in_storage};
570 =item Arguments: none
572 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
576 Throws an exception if the object is not in the database according to
577 L</in_storage>. Also throws an exception if a proper WHERE clause
578 uniquely identifying the database row can not be constructed (see
579 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
582 The object is still perfectly usable, but L</in_storage> will
583 now return 0 and the object must be reinserted using L</insert>
584 before it can be used to L</update> the row again.
586 If you delete an object in a class with a C<has_many> relationship, an
587 attempt is made to delete all the related objects as well. To turn
588 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
589 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
590 database-level cascade or restrict will take precedence over a
591 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
592 main row first> and only then attempts to delete any remaining related
595 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
596 and the transaction subsequently fails, the result object will remain marked as
597 not being in storage. If you know for a fact that the object is still in
598 storage (i.e. by inspecting the cause of the transaction's failure), you can
599 use C<< $obj->in_storage(1) >> to restore consistency between the object and
600 the database. This would allow a subsequent C<< $obj->delete >> to work
603 See also L<DBIx::Class::ResultSet/delete>.
610 $self->throw_exception( "Not in database" ) unless $self->in_storage;
612 $self->result_source->storage->delete(
613 $self->result_source, $self->_storage_ident_condition
616 delete $self->{_column_data_in_storage};
617 $self->in_storage(0);
620 my $rsrc = try { $self->result_source_instance }
621 or $self->throw_exception("Can't do class delete without a ResultSource instance");
623 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
624 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
625 $rsrc->resultset->search(@_)->delete;
632 my $val = $row->get_column($col);
636 =item Arguments: $columnname
638 =item Return Value: The value of the column
642 Throws an exception if the column name given doesn't exist according
643 to L<has_column|DBIx::Class::ResultSource/has_column>.
645 Returns a raw column value from the result object, if it has already
646 been fetched from the database or set by an accessor.
648 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
649 will be deflated and returned.
651 Note that if you used the C<columns> or the C<select/as>
652 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
653 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
654 this method will return C<undef> even if the database contains some value.
656 To retrieve all loaded column values as a hash, use L</get_columns>.
661 my ($self, $column) = @_;
662 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
663 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
664 if (exists $self->{_inflated_column}{$column}) {
665 return $self->store_column($column,
666 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
668 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
672 =head2 has_column_loaded
674 if ( $row->has_column_loaded($col) ) {
675 print "$col has been loaded from db";
680 =item Arguments: $columnname
682 =item Return Value: 0|1
686 Returns a true value if the column value has been loaded from the
687 database (or set locally).
691 sub has_column_loaded {
692 my ($self, $column) = @_;
693 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
694 return 1 if exists $self->{_inflated_column}{$column};
695 return exists $self->{_column_data}{$column};
700 my %data = $row->get_columns;
704 =item Arguments: none
706 =item Return Value: A hash of columnname, value pairs.
710 Returns all loaded column data as a hash, containing raw values. To
711 get just one value for a particular column, use L</get_column>.
713 See L</get_inflated_columns> to get the inflated values.
719 if (exists $self->{_inflated_column}) {
720 foreach my $col (keys %{$self->{_inflated_column}}) {
721 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
722 unless exists $self->{_column_data}{$col};
725 return %{$self->{_column_data}};
728 =head2 get_dirty_columns
730 my %data = $row->get_dirty_columns;
734 =item Arguments: none
736 =item Return Value: A hash of column, value pairs
740 Only returns the column, value pairs for those columns that have been
741 changed on this object since the last L</update> or L</insert> call.
743 See L</get_columns> to fetch all column/value pairs.
747 sub get_dirty_columns {
749 return map { $_ => $self->{_column_data}{$_} }
750 keys %{$self->{_dirty_columns}};
753 =head2 make_column_dirty
755 $row->make_column_dirty($col)
759 =item Arguments: $columnname
761 =item Return Value: not defined
765 Throws an exception if the column does not exist.
767 Marks a column as having been changed regardless of whether it has
772 sub make_column_dirty {
773 my ($self, $column) = @_;
775 $self->throw_exception( "No such column '${column}'" )
776 unless exists $self->{_column_data}{$column} || $self->has_column($column);
778 # the entire clean/dirty code relies on exists, not on true/false
779 return 1 if exists $self->{_dirty_columns}{$column};
781 $self->{_dirty_columns}{$column} = 1;
783 # if we are just now making the column dirty, and if there is an inflated
784 # value, force it over the deflated one
785 if (exists $self->{_inflated_column}{$column}) {
786 $self->store_column($column,
787 $self->_deflated_column(
788 $column, $self->{_inflated_column}{$column}
794 =head2 get_inflated_columns
796 my %inflated_data = $obj->get_inflated_columns;
800 =item Arguments: none
802 =item Return Value: A hash of column, object|value pairs
806 Returns a hash of all column keys and associated values. Values for any
807 columns set to use inflation will be inflated and returns as objects.
809 See L</get_columns> to get the uninflated values.
811 See L<DBIx::Class::InflateColumn> for how to setup inflation.
815 sub get_inflated_columns {
818 my $loaded_colinfo = $self->columns_info ([
819 grep { $self->has_column_loaded($_) } $self->columns
823 for my $col (keys %$loaded_colinfo) {
824 if (exists $loaded_colinfo->{$col}{accessor}) {
825 my $acc = $loaded_colinfo->{$col}{accessor};
826 $inflated{$col} = $self->$acc if defined $acc;
829 $inflated{$col} = $self->$col;
833 # return all loaded columns with the inflations overlayed on top
834 return %{ { $self->get_columns, %inflated } };
837 sub _is_column_numeric {
838 my ($self, $column) = @_;
839 my $colinfo = $self->column_info ($column);
841 # cache for speed (the object may *not* have a resultsource instance)
843 ! defined $colinfo->{is_numeric}
845 my $storage = try { $self->result_source->schema->storage }
847 $colinfo->{is_numeric} =
848 $storage->is_datatype_numeric ($colinfo->{data_type})
854 return $colinfo->{is_numeric};
859 $row->set_column($col => $val);
863 =item Arguments: $columnname, $value
865 =item Return Value: $value
869 Sets a raw column value. If the new value is different from the old one,
870 the column is marked as dirty for when you next call L</update>.
872 If passed an object or reference as a value, this method will happily
873 attempt to store it, and a later L</insert> or L</update> will try and
874 stringify/numify as appropriate. To set an object to be deflated
875 instead, see L</set_inflated_columns>, or better yet, use L</$column_accessor>.
880 my ($self, $column, $new_value) = @_;
882 my $had_value = $self->has_column_loaded($column);
883 my ($old_value, $in_storage) = ($self->get_column($column), $self->in_storage)
886 $new_value = $self->store_column($column, $new_value);
889 $self->{_dirty_columns}{$column}
891 $in_storage # no point tracking dirtyness on uninserted data
892 ? ! $self->_eq_column_values ($column, $old_value, $new_value)
897 # FIXME sadly the update code just checks for keys, not for their value
898 $self->{_dirty_columns}{$column} = 1;
900 # Clear out the relation/inflation cache related to this column
902 # FIXME - this is a quick *largely incorrect* hack, pending a more
903 # serious rework during the merge of single and filter rels
904 my $rels = $self->result_source->{_relationships};
905 for my $rel (keys %$rels) {
907 my $acc = $rels->{$rel}{attrs}{accessor} || '';
909 if ( $acc eq 'single' and $rels->{$rel}{attrs}{fk_columns}{$column} ) {
910 delete $self->{related_resultsets}{$rel};
911 delete $self->{_relationship_data}{$rel};
912 #delete $self->{_inflated_column}{$rel};
914 elsif ( $acc eq 'filter' and $rel eq $column) {
915 delete $self->{related_resultsets}{$rel};
916 #delete $self->{_relationship_data}{$rel};
917 delete $self->{_inflated_column}{$rel};
922 # value change from something (even if NULL)
925 # no storage - no storage-value
928 # no value already stored (multiple changes before commit to storage)
929 ! exists $self->{_column_data_in_storage}{$column}
931 $self->_track_storage_value($column)
933 $self->{_column_data_in_storage}{$column} = $old_value;
940 sub _eq_column_values {
941 my ($self, $col, $old, $new) = @_;
943 if (defined $old xor defined $new) {
946 elsif (not defined $old) { # both undef
949 elsif ($old eq $new) {
952 elsif ($self->_is_column_numeric($col)) { # do a numeric comparison if datatype allows it
960 # returns a boolean indicating if the passed column should have its original
961 # value tracked between column changes and commitment to storage
962 sub _track_storage_value {
963 my ($self, $col) = @_;
964 return defined first { $col eq $_ } ($self->primary_columns);
969 $row->set_columns({ $col => $val, ... });
973 =item Arguments: \%columndata
975 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
979 Sets multiple column, raw value pairs at once.
981 Works as L</set_column>.
986 my ($self,$data) = @_;
987 foreach my $col (keys %$data) {
988 $self->set_column($col,$data->{$col});
993 =head2 set_inflated_columns
995 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
999 =item Arguments: \%columndata
1001 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1005 Sets more than one column value at once. Any inflated values are
1006 deflated and the raw values stored.
1008 Any related values passed as Result objects, using the relation name as a
1009 key, are reduced to the appropriate foreign key values and stored. If
1010 instead of related result objects, a hashref of column, value data is
1011 passed, will create the related object first then store.
1013 Will even accept arrayrefs of data as a value to a
1014 L<DBIx::Class::Relationship/has_many> key, and create the related
1015 objects if necessary.
1017 Be aware that the input hashref might be edited in place, so don't rely
1018 on it being the same after a call to C<set_inflated_columns>. If you
1019 need to preserve the hashref, it is sufficient to pass a shallow copy
1020 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
1022 See also L<DBIx::Class::Relationship::Base/set_from_related>.
1026 sub set_inflated_columns {
1027 my ( $self, $upd ) = @_;
1028 foreach my $key (keys %$upd) {
1029 if (ref $upd->{$key}) {
1030 my $info = $self->relationship_info($key);
1031 my $acc_type = $info->{attrs}{accessor} || '';
1032 if ($acc_type eq 'single') {
1033 my $rel = delete $upd->{$key};
1034 $self->set_from_related($key => $rel);
1035 $self->{_relationship_data}{$key} = $rel;
1037 elsif ($acc_type eq 'multi') {
1038 $self->throw_exception(
1039 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
1042 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
1043 $self->set_inflated_column($key, delete $upd->{$key});
1047 $self->set_columns($upd);
1052 my $copy = $orig->copy({ change => $to, ... });
1056 =item Arguments: \%replacementdata
1058 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> copy
1062 Inserts a new row into the database, as a copy of the original
1063 object. If a hashref of replacement data is supplied, these will take
1064 precedence over data in the original. Also any columns which have
1065 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
1066 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
1067 so that the database can insert its own autoincremented values into
1070 Relationships will be followed by the copy procedure B<only> if the
1071 relationship specifies a true value for its
1072 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1073 is set by default on C<has_many> relationships and unset on all others.
1078 my ($self, $changes) = @_;
1080 my $col_data = { %{$self->{_column_data}} };
1082 my $colinfo = $self->columns_info([ keys %$col_data ]);
1083 foreach my $col (keys %$col_data) {
1084 delete $col_data->{$col}
1085 if $colinfo->{$col}{is_auto_increment};
1088 my $new = { _column_data => $col_data };
1089 bless $new, ref $self;
1091 $new->result_source($self->result_source);
1092 $new->set_inflated_columns($changes);
1095 # Its possible we'll have 2 relations to the same Source. We need to make
1096 # sure we don't try to insert the same row twice else we'll violate unique
1098 my $rels_copied = {};
1100 foreach my $rel ($self->result_source->relationships) {
1101 my $rel_info = $self->result_source->relationship_info($rel);
1103 next unless $rel_info->{attrs}{cascade_copy};
1105 my $resolved = $self->result_source->_resolve_condition(
1106 $rel_info->{cond}, $rel, $new, $rel
1109 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1110 foreach my $related ($self->search_related($rel)) {
1111 my $id_str = join("\0", $related->id);
1112 next if $copied->{$id_str};
1113 $copied->{$id_str} = 1;
1114 my $rel_copy = $related->copy($resolved);
1123 $row->store_column($col => $val);
1127 =item Arguments: $columnname, $value
1129 =item Return Value: The value sent to storage
1133 Set a raw value for a column without marking it as changed. This
1134 method is used internally by L</set_column> which you should probably
1137 This is the lowest level at which data is set on a result object,
1138 extend this method to catch all data setting methods.
1143 my ($self, $column, $value) = @_;
1144 $self->throw_exception( "No such column '${column}'" )
1145 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1146 $self->throw_exception( "set_column called for ${column} without value" )
1148 return $self->{_column_data}{$column} = $value;
1151 =head2 inflate_result
1153 Class->inflate_result($result_source, \%me, \%prefetch?)
1157 =item Arguments: L<$result_source|DBIx::Class::ResultSource>, \%columndata, \%prefetcheddata
1159 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1163 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1164 database and turn it into result objects call this method.
1166 Extend this method in your Result classes to hook into this process,
1167 for example to rebless the result into a different class.
1169 Reblessing can also be done more easily by setting C<result_class> in
1170 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1172 Different types of results can also be created from a particular
1173 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1177 sub inflate_result {
1178 my ($class, $source, $me, $prefetch) = @_;
1181 { _column_data => $me, _result_source => $source },
1182 ref $class || $class
1186 for my $pre ( keys %$prefetch ) {
1190 @{$prefetch->{$pre}||[]}
1192 ref($prefetch->{$pre}) ne $DBIx::Class::ResultSource::RowParser::Util::null_branch_class
1194 my $pre_source = try {
1195 $source->related_source($pre)
1198 "Inflation into non-existent relationship '%s' of '%s' requested",
1200 $source->source_name,
1202 if (my ($colname) = sort { length($a) <=> length ($b) } keys %{$prefetch->{$pre}[0] || {}} ) {
1203 $err .= sprintf ", check the inflation specification (columns/as) ending in '...%s.%s'",
1208 $source->throw_exception($err);
1211 @pre_objects = map {
1212 $pre_source->result_class->inflate_result( $pre_source, @$_ )
1213 } ( ref $prefetch->{$pre}[0] eq 'ARRAY' ? @{$prefetch->{$pre}} : $prefetch->{$pre} );
1216 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1217 or $class->throw_exception("No accessor type declared for prefetched relationship '$pre'");
1219 if ($accessor eq 'single') {
1220 $new->{_relationship_data}{$pre} = $pre_objects[0];
1222 elsif ($accessor eq 'filter') {
1223 $new->{_inflated_column}{$pre} = $pre_objects[0];
1226 $new->related_resultset($pre)->set_cache(\@pre_objects);
1230 $new->in_storage (1);
1234 =head2 update_or_insert
1236 $row->update_or_insert
1240 =item Arguments: none
1242 =item Return Value: Result of update or insert operation
1246 L</Update>s the object if it's already in the database, according to
1247 L</in_storage>, else L</insert>s it.
1249 =head2 insert_or_update
1251 $obj->insert_or_update
1253 Alias for L</update_or_insert>
1257 sub insert_or_update { shift->update_or_insert(@_) }
1259 sub update_or_insert {
1261 return ($self->in_storage ? $self->update : $self->insert);
1266 my @changed_col_names = $row->is_changed();
1267 if ($row->is_changed()) { ... }
1271 =item Arguments: none
1273 =item Return Value: 0|1 or @columnnames
1277 In list context returns a list of columns with uncommited changes, or
1278 in scalar context returns a true value if there are uncommitted
1284 return keys %{shift->{_dirty_columns} || {}};
1287 =head2 is_column_changed
1289 if ($row->is_column_changed('col')) { ... }
1293 =item Arguments: $columname
1295 =item Return Value: 0|1
1299 Returns a true value if the column has uncommitted changes.
1303 sub is_column_changed {
1304 my( $self, $col ) = @_;
1305 return exists $self->{_dirty_columns}->{$col};
1308 =head2 result_source
1310 my $resultsource = $row->result_source;
1314 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1316 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1320 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1325 $_[0]->throw_exception( 'result_source can be called on instances only' )
1329 ? $_[0]->{_result_source} = $_[1]
1331 # note this is a || not a ||=, the difference is important
1332 : $_[0]->{_result_source} || do {
1333 my $class = ref $_[0];
1334 $_[0]->can('result_source_instance')
1335 ? $_[0]->result_source_instance
1336 : $_[0]->throw_exception(
1337 "No result source instance registered for $class, did you forget to call $class->table(...) ?"
1343 =head2 register_column
1345 $column_info = { .... };
1346 $class->register_column($column_name, $column_info);
1350 =item Arguments: $columnname, \%columninfo
1352 =item Return Value: not defined
1356 Registers a column on the class. If the column_info has an 'accessor'
1357 key, creates an accessor named after the value if defined; if there is
1358 no such key, creates an accessor with the same name as the column
1360 The column_info attributes are described in
1361 L<DBIx::Class::ResultSource/add_columns>
1365 sub register_column {
1366 my ($class, $col, $info) = @_;
1368 if (exists $info->{accessor}) {
1369 return unless defined $info->{accessor};
1370 $acc = [ $info->{accessor}, $col ];
1372 $class->mk_group_accessors('column' => $acc);
1375 =head2 get_from_storage
1377 my $copy = $row->get_from_storage($attrs)
1381 =item Arguments: \%attrs
1383 =item Return Value: A Result object
1387 Fetches a fresh copy of the Result object from the database and returns it.
1388 Throws an exception if a proper WHERE clause identifying the database row
1389 can not be constructed (i.e. if the original object does not contain its
1391 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1392 ). If passed the \%attrs argument, will first apply these attributes to
1393 the resultset used to find the row.
1395 This copy can then be used to compare to an existing result object, to
1396 determine if any changes have been made in the database since it was
1399 To just update your Result object with any latest changes from the
1400 database, use L</discard_changes> instead.
1402 The \%attrs argument should be compatible with
1403 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1407 sub get_from_storage {
1408 my $self = shift @_;
1409 my $attrs = shift @_;
1410 my $resultset = $self->result_source->resultset;
1412 if(defined $attrs) {
1413 $resultset = $resultset->search(undef, $attrs);
1416 return $resultset->find($self->_storage_ident_condition);
1419 =head2 discard_changes
1421 $row->discard_changes
1425 =item Arguments: none or $attrs
1427 =item Return Value: self (updates object in-place)
1431 Re-selects the row from the database, losing any changes that had
1432 been made. Throws an exception if a proper C<WHERE> clause identifying
1433 the database row can not be constructed (i.e. if the original object
1434 does not contain its entire
1435 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>).
1437 This method can also be used to refresh from storage, retrieving any
1438 changes made since the row was last read from storage.
1440 $attrs, if supplied, is expected to be a hashref of attributes suitable for passing as the
1441 second argument to C<< $resultset->search($cond, $attrs) >>;
1443 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1444 storage, please kept in mind that if you L</discard_changes> on a row that you
1445 just updated or created, you should wrap the entire bit inside a transaction.
1446 Otherwise you run the risk that you insert or update to the master database
1447 but read from a replicant database that has not yet been updated from the
1448 master. This will result in unexpected results.
1452 sub discard_changes {
1453 my ($self, $attrs) = @_;
1454 return unless $self->in_storage; # Don't reload if we aren't real!
1456 # add a replication default to read from the master only
1457 $attrs = { force_pool => 'master', %{$attrs||{}} };
1459 if( my $current_storage = $self->get_from_storage($attrs)) {
1461 # Set $self to the current.
1462 %$self = %$current_storage;
1464 # Avoid a possible infinite loop with
1465 # sub DESTROY { $_[0]->discard_changes }
1466 bless $current_storage, 'Do::Not::Exist';
1471 $self->in_storage(0);
1476 =head2 throw_exception
1478 See L<DBIx::Class::Schema/throw_exception>.
1482 sub throw_exception {
1485 if (ref $self && ref $self->result_source ) {
1486 $self->result_source->throw_exception(@_)
1489 DBIx::Class::Exception->throw(@_);
1499 =item Arguments: none
1501 =item Returns: A list of primary key values
1505 Returns the primary key(s) for a row. Can't be called as a class method.
1506 Actually implemented in L<DBIx::Class::PK>
1508 =head1 AUTHOR AND CONTRIBUTORS
1510 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
1514 You may distribute this code under the same terms as Perl itself.