1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
8 use DBIx::Class::Exception;
9 use Scalar::Util 'blessed';
10 use List::Util 'first';
19 $ENV{DBIC_MULTICREATE_DEBUG}
28 DBIx::Class::Row - Basic row methods
34 This class is responsible for defining and doing basic operations on rows
35 derived from L<DBIx::Class::ResultSource> objects.
37 Row objects are returned from L<DBIx::Class::ResultSet>s using the
38 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
39 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
40 as well as invocations of 'single' (
41 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
42 L<has_one|DBIx::Class::Relationship/has_one> or
43 L<might_have|DBIx::Class::Relationship/might_have>)
44 relationship accessors of L<DBIx::Class::Row> objects.
50 my $row = My::Class->new(\%attrs);
52 my $row = $schema->resultset('MySource')->new(\%colsandvalues);
56 =item Arguments: \%attrs or \%colsandvalues
58 =item Returns: A Row object
62 While you can create a new row object by calling C<new> directly on
63 this class, you are better off calling it on a
64 L<DBIx::Class::ResultSet> object.
66 When calling it directly, you will not get a complete, usable row
67 object until you pass or set the C<result_source> attribute, to a
68 L<DBIx::Class::ResultSource> instance that is attached to a
69 L<DBIx::Class::Schema> with a valid connection.
71 C<$attrs> is a hashref of column name, value data. It can also contain
72 some other attributes such as the C<result_source>.
74 Passing an object, or an arrayref of objects as a value will call
75 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
76 passed a hashref or an arrayref of hashrefs as the value, these will
77 be turned into objects via new_related, and treated as if you had
80 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
82 Please note that if a value is not passed to new, no value will be sent
83 in the SQL INSERT call, and the column will therefore assume whatever
84 default value was specified in your database. While DBIC will retrieve the
85 value of autoincrement columns, it will never make an explicit database
86 trip to retrieve default values assigned by the RDBMS. You can explicitly
87 request that all values be fetched back from the database by calling
88 L</discard_changes>, or you can supply an explicit C<undef> to columns
89 with NULL as the default, and save yourself a SELECT.
93 The behavior described above will backfire if you use a foreign key column
94 with a database-defined default. If you call the relationship accessor on
95 an object that doesn't have a set value for the FK column, DBIC will throw
96 an exception, as it has no way of knowing the PK of the related object (if
101 ## 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().
102 ## This only works because DBIC doesnt yet care to check whether the new_related objects have been passed all their mandatory columns
103 ## When doing the later insert, we need to make sure the PKs are set.
104 ## using _relationship_data in new and funky ways..
105 ## check Relationship::CascadeActions and Relationship::Accessor for compat
108 sub __new_related_find_or_new_helper {
109 my ($self, $relname, $data) = @_;
111 my $rsrc = $self->result_source;
113 # create a mock-object so all new/set_column component overrides will run:
114 my $rel_rs = $rsrc->related_source($relname)->resultset;
115 my $new_rel_obj = $rel_rs->new_result($data);
116 my $proc_data = { $new_rel_obj->get_columns };
118 if ($self->__their_pk_needs_us($relname)) {
119 MULTICREATE_DEBUG and warn "MC $self constructing $relname via new_result";
122 elsif ($rsrc->_pk_depends_on($relname, $proc_data )) {
123 if (! keys %$proc_data) {
124 # there is nothing to search for - blind create
125 MULTICREATE_DEBUG and warn "MC $self constructing default-insert $relname";
128 MULTICREATE_DEBUG and warn "MC $self constructing $relname via find_or_new";
129 # this is not *really* find or new, as we don't want to double-new the
130 # data (thus potentially double encoding or whatever)
131 my $exists = $rel_rs->find ($proc_data);
132 return $exists if $exists;
137 my $us = $rsrc->source_name;
138 $self->throw_exception (
139 "Unable to determine relationship '$relname' direction from '$us', "
140 . "possibly due to a missing reverse-relationship on '$relname' to '$us'."
145 sub __their_pk_needs_us { # this should maybe be in resultsource.
146 my ($self, $relname) = @_;
147 my $source = $self->result_source;
148 my $reverse = $source->reverse_relationship_info($relname);
149 my $rel_source = $source->related_source($relname);
150 my $us = { $self->get_columns };
151 foreach my $key (keys %$reverse) {
152 # if their primary key depends on us, then we have to
153 # just create a result and we'll fill it out afterwards
154 return 1 if $rel_source->_pk_depends_on($key, $us);
160 my ($class, $attrs) = @_;
161 $class = ref $class if ref $class;
163 my $new = bless { _column_data => {} }, $class;
166 $new->throw_exception("attrs must be a hashref")
167 unless ref($attrs) eq 'HASH';
169 my $source = delete $attrs->{-result_source};
170 if ( my $h = delete $attrs->{-source_handle} ) {
171 $source ||= $h->resolve;
174 $new->result_source($source) if $source;
176 if (my $col_from_rel = delete $attrs->{-cols_from_relations}) {
177 @{$new->{_ignore_at_insert}={}}{@$col_from_rel} = ();
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(!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(!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(!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. To insert an
272 entirely new row into the database, use L<DBIx::Class::ResultSet/create>.
274 To fetch an uninserted row object, call
275 L<new|DBIx::Class::ResultSet/new> on a resultset.
277 This will also insert any uninserted, related objects held inside this
278 one, see L<DBIx::Class::ResultSet/create> for more details.
284 return $self if $self->in_storage;
285 my $source = $self->result_source;
286 $self->throw_exception("No result_source set on this object; can't insert")
289 my $storage = $source->storage;
293 # Check if we stored uninserted relobjs here in new()
294 my %related_stuff = (%{$self->{_relationship_data} || {}},
295 %{$self->{_inflated_column} || {}});
297 # insert what needs to be inserted before us
299 for my $relname (keys %related_stuff) {
300 my $rel_obj = $related_stuff{$relname};
302 if (! $self->{_rel_in_storage}{$relname}) {
303 next unless (blessed $rel_obj && $rel_obj->isa('DBIx::Class::Row'));
305 next unless $source->_pk_depends_on(
306 $relname, { $rel_obj->get_columns }
309 # The guard will save us if we blow out of this scope via die
310 $rollback_guard ||= $storage->txn_scope_guard;
312 MULTICREATE_DEBUG and warn "MC $self pre-reconstructing $relname $rel_obj\n";
314 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_columns };
317 # if there are no keys - nothing to search for
318 if (keys %$them and $existing = $self->result_source
319 ->related_source($relname)
323 %{$rel_obj} = %{$existing};
329 $self->{_rel_in_storage}{$relname} = 1;
332 $self->set_from_related($relname, $rel_obj);
333 delete $related_stuff{$relname};
336 # start a transaction here if not started yet and there is more stuff
338 if (keys %related_stuff) {
339 $rollback_guard ||= $storage->txn_scope_guard
342 MULTICREATE_DEBUG and do {
343 no warnings 'uninitialized';
344 warn "MC $self inserting (".join(', ', $self->get_columns).")\n";
347 # perform the insert - the storage will return everything it is asked to
348 # (autoinc primary columns and any retrieve_on_insert columns)
349 my %current_rowdata = $self->get_columns;
350 my $returned_cols = $storage->insert(
352 { %current_rowdata }, # what to insert, copy because the storage *will* change it
355 for (keys %$returned_cols) {
356 $self->store_column($_, $returned_cols->{$_})
357 # this ensures we fire store_column only once
358 # (some asshats like overriding it)
360 (!exists $current_rowdata{$_})
362 (defined $current_rowdata{$_} xor defined $returned_cols->{$_})
364 (defined $current_rowdata{$_} and $current_rowdata{$_} ne $returned_cols->{$_})
368 delete $self->{_column_data_in_storage};
369 $self->in_storage(1);
371 $self->{_dirty_columns} = {};
372 $self->{related_resultsets} = {};
374 foreach my $relname (keys %related_stuff) {
375 next unless $source->has_relationship ($relname);
377 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
378 ? @{$related_stuff{$relname}}
379 : $related_stuff{$relname}
382 if (@cands && blessed $cands[0] && $cands[0]->isa('DBIx::Class::Row')
384 my $reverse = $source->reverse_relationship_info($relname);
385 foreach my $obj (@cands) {
386 $obj->set_from_related($_, $self) for keys %$reverse;
387 if ($self->__their_pk_needs_us($relname)) {
388 if (exists $self->{_ignore_at_insert}{$relname}) {
389 MULTICREATE_DEBUG and warn "MC $self skipping post-insert on $relname";
392 MULTICREATE_DEBUG and warn "MC $self inserting $relname $obj";
396 MULTICREATE_DEBUG and warn "MC $self post-inserting $obj";
403 delete $self->{_ignore_at_insert};
405 $rollback_guard->commit if $rollback_guard;
412 $row->in_storage; # Get value
413 $row->in_storage(1); # Set value
417 =item Arguments: none or 1|0
423 Indicates whether the object exists as a row in the database or
424 not. This is set to true when L<DBIx::Class::ResultSet/find>,
425 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
428 Creating a row object using L<DBIx::Class::ResultSet/new>, or calling
429 L</delete> on one, sets it to false.
434 my ($self, $val) = @_;
435 $self->{_in_storage} = $val if @_ > 1;
436 return $self->{_in_storage} ? 1 : 0;
441 $row->update(\%columns?)
445 =item Arguments: none or a hashref
447 =item Returns: The Row object
451 Throws an exception if the row object is not yet in the database,
452 according to L</in_storage>.
454 This method issues an SQL UPDATE query to commit any changes to the
455 object to the database if required (see L</get_dirty_columns>).
456 It throws an exception if a proper WHERE clause uniquely identifying
457 the database row can not be constructed (see
458 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
461 Also takes an optional hashref of C<< column_name => value >> pairs
462 to update on the object first. Be aware that the hashref will be
463 passed to C<set_inflated_columns>, which might edit it in place, so
464 don't rely on it being the same after a call to C<update>. If you
465 need to preserve the hashref, it is sufficient to pass a shallow copy
466 to C<update>, e.g. ( { %{ $href } } )
468 If the values passed or any of the column values set on the object
469 contain scalar references, e.g.:
471 $row->last_modified(\'NOW()');
473 $row->update({ last_modified => \'NOW()' });
475 The update will pass the values verbatim into SQL. (See
476 L<SQL::Abstract> docs). The values in your Row object will NOT change
477 as a result of the update call, if you want the object to be updated
478 with the actual values from the database, call L</discard_changes>
481 $row->update()->discard_changes();
483 To determine before calling this method, which column values have
484 changed and will be updated, call L</get_dirty_columns>.
486 To check if any columns will be updated, call L</is_changed>.
488 To force a column to be updated, call L</make_column_dirty> before
494 my ($self, $upd) = @_;
496 $self->set_inflated_columns($upd) if $upd;
498 my %to_update = $self->get_dirty_columns
501 $self->throw_exception( "Not in database" ) unless $self->in_storage;
503 my $rows = $self->result_source->storage->update(
504 $self->result_source, \%to_update, $self->_storage_ident_condition
507 $self->throw_exception( "Can't update ${self}: row not found" );
508 } elsif ($rows > 1) {
509 $self->throw_exception("Can't update ${self}: updated more than one row");
511 $self->{_dirty_columns} = {};
512 $self->{related_resultsets} = {};
513 delete $self->{_column_data_in_storage};
523 =item Arguments: none
525 =item Returns: The Row object
529 Throws an exception if the object is not in the database according to
530 L</in_storage>. Also throws an exception if a proper WHERE clause
531 uniquely identifying the database row can not be constructed (see
532 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
535 The object is still perfectly usable, but L</in_storage> will
536 now return 0 and the object must be reinserted using L</insert>
537 before it can be used to L</update> the row again.
539 If you delete an object in a class with a C<has_many> relationship, an
540 attempt is made to delete all the related objects as well. To turn
541 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
542 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
543 database-level cascade or restrict will take precedence over a
544 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
545 main row first> and only then attempts to delete any remaining related
548 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
549 and the transaction subsequently fails, the row object will remain marked as
550 not being in storage. If you know for a fact that the object is still in
551 storage (i.e. by inspecting the cause of the transaction's failure), you can
552 use C<< $obj->in_storage(1) >> to restore consistency between the object and
553 the database. This would allow a subsequent C<< $obj->delete >> to work
556 See also L<DBIx::Class::ResultSet/delete>.
563 $self->throw_exception( "Not in database" ) unless $self->in_storage;
565 $self->result_source->storage->delete(
566 $self->result_source, $self->_storage_ident_condition
569 delete $self->{_column_data_in_storage};
570 $self->in_storage(undef);
573 my $rsrc = try { $self->result_source_instance }
574 or $self->throw_exception("Can't do class delete without a ResultSource instance");
576 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
577 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
578 $rsrc->resultset->search(@_)->delete;
585 my $val = $row->get_column($col);
589 =item Arguments: $columnname
591 =item Returns: The value of the column
595 Throws an exception if the column name given doesn't exist according
598 Returns a raw column value from the row object, if it has already
599 been fetched from the database or set by an accessor.
601 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
602 will be deflated and returned.
604 Note that if you used the C<columns> or the C<select/as>
605 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
606 which C<$row> was derived, and B<did not include> C<$columnname> in the list,
607 this method will return C<undef> even if the database contains some value.
609 To retrieve all loaded column values as a hash, use L</get_columns>.
614 my ($self, $column) = @_;
615 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
616 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
617 if (exists $self->{_inflated_column}{$column}) {
618 return $self->store_column($column,
619 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
621 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
625 =head2 has_column_loaded
627 if ( $row->has_column_loaded($col) ) {
628 print "$col has been loaded from db";
633 =item Arguments: $columnname
639 Returns a true value if the column value has been loaded from the
640 database (or set locally).
644 sub has_column_loaded {
645 my ($self, $column) = @_;
646 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
647 return 1 if exists $self->{_inflated_column}{$column};
648 return exists $self->{_column_data}{$column};
653 my %data = $row->get_columns;
657 =item Arguments: none
659 =item Returns: A hash of columnname, value pairs.
663 Returns all loaded column data as a hash, containing raw values. To
664 get just one value for a particular column, use L</get_column>.
666 See L</get_inflated_columns> to get the inflated values.
672 if (exists $self->{_inflated_column}) {
673 foreach my $col (keys %{$self->{_inflated_column}}) {
674 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}))
675 unless exists $self->{_column_data}{$col};
678 return %{$self->{_column_data}};
681 =head2 get_dirty_columns
683 my %data = $row->get_dirty_columns;
687 =item Arguments: none
689 =item Returns: A hash of column, value pairs
693 Only returns the column, value pairs for those columns that have been
694 changed on this object since the last L</update> or L</insert> call.
696 See L</get_columns> to fetch all column/value pairs.
700 sub get_dirty_columns {
702 return map { $_ => $self->{_column_data}{$_} }
703 keys %{$self->{_dirty_columns}};
706 =head2 make_column_dirty
708 $row->make_column_dirty($col)
712 =item Arguments: $columnname
714 =item Returns: undefined
718 Throws an exception if the column does not exist.
720 Marks a column as having been changed regardless of whether it has
724 sub make_column_dirty {
725 my ($self, $column) = @_;
727 $self->throw_exception( "No such column '${column}'" )
728 unless exists $self->{_column_data}{$column} || $self->has_column($column);
730 # the entire clean/dirty code relies on exists, not on true/false
731 return 1 if exists $self->{_dirty_columns}{$column};
733 $self->{_dirty_columns}{$column} = 1;
735 # if we are just now making the column dirty, and if there is an inflated
736 # value, force it over the deflated one
737 if (exists $self->{_inflated_column}{$column}) {
738 $self->store_column($column,
739 $self->_deflated_column(
740 $column, $self->{_inflated_column}{$column}
746 =head2 get_inflated_columns
748 my %inflated_data = $obj->get_inflated_columns;
752 =item Arguments: none
754 =item Returns: A hash of column, object|value pairs
758 Returns a hash of all column keys and associated values. Values for any
759 columns set to use inflation will be inflated and returns as objects.
761 See L</get_columns> to get the uninflated values.
763 See L<DBIx::Class::InflateColumn> for how to setup inflation.
767 sub get_inflated_columns {
770 my $loaded_colinfo = $self->columns_info ([
771 grep { $self->has_column_loaded($_) } $self->columns
775 for my $col (keys %$loaded_colinfo) {
776 if (exists $loaded_colinfo->{$col}{accessor}) {
777 my $acc = $loaded_colinfo->{$col}{accessor};
778 $inflated{$col} = $self->$acc if defined $acc;
781 $inflated{$col} = $self->$col;
785 # return all loaded columns with the inflations overlayed on top
786 return %{ { $self->get_columns, %inflated } };
789 sub _is_column_numeric {
790 my ($self, $column) = @_;
791 my $colinfo = $self->column_info ($column);
793 # cache for speed (the object may *not* have a resultsource instance)
795 ! defined $colinfo->{is_numeric}
797 my $storage = try { $self->result_source->schema->storage }
799 $colinfo->{is_numeric} =
800 $storage->is_datatype_numeric ($colinfo->{data_type})
806 return $colinfo->{is_numeric};
811 $row->set_column($col => $val);
815 =item Arguments: $columnname, $value
817 =item Returns: $value
821 Sets a raw column value. If the new value is different from the old one,
822 the column is marked as dirty for when you next call L</update>.
824 If passed an object or reference as a value, this method will happily
825 attempt to store it, and a later L</insert> or L</update> will try and
826 stringify/numify as appropriate. To set an object to be deflated
827 instead, see L</set_inflated_columns>.
832 my ($self, $column, $new_value) = @_;
834 my $had_value = $self->has_column_loaded($column);
835 my ($old_value, $in_storage) = ($self->get_column($column), $self->in_storage)
838 $new_value = $self->store_column($column, $new_value);
841 $self->{_dirty_columns}{$column}
843 $in_storage # no point tracking dirtyness on uninserted data
844 ? ! $self->_eq_column_values ($column, $old_value, $new_value)
849 # FIXME sadly the update code just checks for keys, not for their value
850 $self->{_dirty_columns}{$column} = 1;
852 # Clear out the relation/inflation cache related to this column
854 # FIXME - this is a quick *largely incorrect* hack, pending a more
855 # serious rework during the merge of single and filter rels
856 my $rels = $self->result_source->{_relationships};
857 for my $rel (keys %$rels) {
859 my $acc = $rels->{$rel}{attrs}{accessor} || '';
861 if ( $acc eq 'single' and $rels->{$rel}{attrs}{fk_columns}{$column} ) {
862 delete $self->{related_resultsets}{$rel};
863 delete $self->{_relationship_data}{$rel};
864 #delete $self->{_inflated_column}{$rel};
866 elsif ( $acc eq 'filter' and $rel eq $column) {
867 delete $self->{related_resultsets}{$rel};
868 #delete $self->{_relationship_data}{$rel};
869 delete $self->{_inflated_column}{$rel};
874 # value change from something (even if NULL)
877 # no storage - no storage-value
880 # no value already stored (multiple changes before commit to storage)
881 ! exists $self->{_column_data_in_storage}{$column}
883 $self->_track_storage_value($column)
885 $self->{_column_data_in_storage}{$column} = $old_value;
892 sub _eq_column_values {
893 my ($self, $col, $old, $new) = @_;
895 if (defined $old xor defined $new) {
898 elsif (not defined $old) { # both undef
901 elsif ($old eq $new) {
904 elsif ($self->_is_column_numeric($col)) { # do a numeric comparison if datatype allows it
912 # returns a boolean indicating if the passed column should have its original
913 # value tracked between column changes and commitment to storage
914 sub _track_storage_value {
915 my ($self, $col) = @_;
916 return defined first { $col eq $_ } ($self->primary_columns);
921 $row->set_columns({ $col => $val, ... });
925 =item Arguments: \%columndata
927 =item Returns: The Row object
931 Sets multiple column, raw value pairs at once.
933 Works as L</set_column>.
938 my ($self,$data) = @_;
939 foreach my $col (keys %$data) {
940 $self->set_column($col,$data->{$col});
945 =head2 set_inflated_columns
947 $row->set_inflated_columns({ $col => $val, $relname => $obj, ... });
951 =item Arguments: \%columndata
953 =item Returns: The Row object
957 Sets more than one column value at once. Any inflated values are
958 deflated and the raw values stored.
960 Any related values passed as Row objects, using the relation name as a
961 key, are reduced to the appropriate foreign key values and stored. If
962 instead of related row objects, a hashref of column, value data is
963 passed, will create the related object first then store.
965 Will even accept arrayrefs of data as a value to a
966 L<DBIx::Class::Relationship/has_many> key, and create the related
967 objects if necessary.
969 Be aware that the input hashref might be edited in place, so don't rely
970 on it being the same after a call to C<set_inflated_columns>. If you
971 need to preserve the hashref, it is sufficient to pass a shallow copy
972 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
974 See also L<DBIx::Class::Relationship::Base/set_from_related>.
978 sub set_inflated_columns {
979 my ( $self, $upd ) = @_;
980 foreach my $key (keys %$upd) {
981 if (ref $upd->{$key}) {
982 my $info = $self->relationship_info($key);
983 my $acc_type = $info->{attrs}{accessor} || '';
984 if ($acc_type eq 'single') {
985 my $rel = delete $upd->{$key};
986 $self->set_from_related($key => $rel);
987 $self->{_relationship_data}{$key} = $rel;
989 elsif ($acc_type eq 'multi') {
990 $self->throw_exception(
991 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
994 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
995 $self->set_inflated_column($key, delete $upd->{$key});
999 $self->set_columns($upd);
1004 my $copy = $orig->copy({ change => $to, ... });
1008 =item Arguments: \%replacementdata
1010 =item Returns: The Row object copy
1014 Inserts a new row into the database, as a copy of the original
1015 object. If a hashref of replacement data is supplied, these will take
1016 precedence over data in the original. Also any columns which have
1017 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
1018 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
1019 so that the database can insert its own autoincremented values into
1022 Relationships will be followed by the copy procedure B<only> if the
1023 relationship specifies a true value for its
1024 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1025 is set by default on C<has_many> relationships and unset on all others.
1030 my ($self, $changes) = @_;
1032 my $col_data = { %{$self->{_column_data}} };
1034 my $colinfo = $self->columns_info([ keys %$col_data ]);
1035 foreach my $col (keys %$col_data) {
1036 delete $col_data->{$col}
1037 if $colinfo->{$col}{is_auto_increment};
1040 my $new = { _column_data => $col_data };
1041 bless $new, ref $self;
1043 $new->result_source($self->result_source);
1044 $new->set_inflated_columns($changes);
1047 # Its possible we'll have 2 relations to the same Source. We need to make
1048 # sure we don't try to insert the same row twice else we'll violate unique
1050 my $rels_copied = {};
1052 foreach my $rel ($self->result_source->relationships) {
1053 my $rel_info = $self->result_source->relationship_info($rel);
1055 next unless $rel_info->{attrs}{cascade_copy};
1057 my $resolved = $self->result_source->_resolve_condition(
1058 $rel_info->{cond}, $rel, $new, $rel
1061 my $copied = $rels_copied->{ $rel_info->{source} } ||= {};
1062 foreach my $related ($self->search_related($rel)) {
1063 my $id_str = join("\0", $related->id);
1064 next if $copied->{$id_str};
1065 $copied->{$id_str} = 1;
1066 my $rel_copy = $related->copy($resolved);
1075 $row->store_column($col => $val);
1079 =item Arguments: $columnname, $value
1081 =item Returns: The value sent to storage
1085 Set a raw value for a column without marking it as changed. This
1086 method is used internally by L</set_column> which you should probably
1089 This is the lowest level at which data is set on a row object,
1090 extend this method to catch all data setting methods.
1095 my ($self, $column, $value) = @_;
1096 $self->throw_exception( "No such column '${column}'" )
1097 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1098 $self->throw_exception( "set_column called for ${column} without value" )
1100 return $self->{_column_data}{$column} = $value;
1103 =head2 inflate_result
1105 Class->inflate_result($result_source, \%me, \%prefetch?)
1109 =item Arguments: $result_source, \%columndata, \%prefetcheddata
1111 =item Returns: A Row object
1115 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1116 database and turn it into row objects call this method.
1118 Extend this method in your Result classes to hook into this process,
1119 for example to rebless the result into a different class.
1121 Reblessing can also be done more easily by setting C<result_class> in
1122 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1124 Different types of results can also be created from a particular
1125 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1129 sub inflate_result {
1130 my ($class, $source, $me, $prefetch) = @_;
1132 $source = $source->resolve
1133 if $source->isa('DBIx::Class::ResultSourceHandle');
1136 { _column_data => $me, _result_source => $source },
1137 ref $class || $class
1140 foreach my $pre (keys %{$prefetch||{}}) {
1142 my (@pre_vals, $is_multi);
1143 if (ref $prefetch->{$pre}[0] eq 'ARRAY') {
1145 @pre_vals = @{$prefetch->{$pre}};
1148 @pre_vals = $prefetch->{$pre};
1151 my $pre_source = try {
1152 $source->related_source($pre)
1155 $class->throw_exception(sprintf
1157 "Can't inflate manual prefetch into non-existent relationship '%s' from '%s', "
1158 . "check the inflation specification (columns/as) ending in '%s.%s'.",
1161 $source->source_name,
1163 (keys %{$pre_vals[0][0]})[0] || 'something.something...',
1167 my $accessor = $source->relationship_info($pre)->{attrs}{accessor}
1168 or $class->throw_exception("No accessor type declared for prefetched $pre");
1170 if (! $is_multi and $accessor eq 'multi') {
1171 $class->throw_exception("Manual prefetch (via select/columns) not supported with accessor 'multi'");
1175 for my $me_pref (@pre_vals) {
1177 # FIXME - this should not be necessary
1178 # the collapser currently *could* return bogus elements with all
1179 # columns set to undef
1181 for (values %{$me_pref->[0]}) {
1187 next unless $has_def;
1189 push @pre_objects, $pre_source->result_class->inflate_result(
1190 $pre_source, @$me_pref
1194 if ($accessor eq 'single') {
1195 $new->{_relationship_data}{$pre} = $pre_objects[0];
1197 elsif ($accessor eq 'filter') {
1198 $new->{_inflated_column}{$pre} = $pre_objects[0];
1201 $new->related_resultset($pre)->set_cache(\@pre_objects);
1204 $new->in_storage (1);
1208 =head2 update_or_insert
1210 $row->update_or_insert
1214 =item Arguments: none
1216 =item Returns: Result of update or insert operation
1220 L</Update>s the object if it's already in the database, according to
1221 L</in_storage>, else L</insert>s it.
1223 =head2 insert_or_update
1225 $obj->insert_or_update
1227 Alias for L</update_or_insert>
1231 sub insert_or_update { shift->update_or_insert(@_) }
1233 sub update_or_insert {
1235 return ($self->in_storage ? $self->update : $self->insert);
1240 my @changed_col_names = $row->is_changed();
1241 if ($row->is_changed()) { ... }
1245 =item Arguments: none
1247 =item Returns: 0|1 or @columnnames
1251 In list context returns a list of columns with uncommited changes, or
1252 in scalar context returns a true value if there are uncommitted
1258 return keys %{shift->{_dirty_columns} || {}};
1261 =head2 is_column_changed
1263 if ($row->is_column_changed('col')) { ... }
1267 =item Arguments: $columname
1273 Returns a true value if the column has uncommitted changes.
1277 sub is_column_changed {
1278 my( $self, $col ) = @_;
1279 return exists $self->{_dirty_columns}->{$col};
1282 =head2 result_source
1284 my $resultsource = $row->result_source;
1288 =item Arguments: $result_source_instance
1290 =item Returns: a ResultSource instance
1294 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1299 $_[0]->throw_exception( 'result_source can be called on instances only' )
1303 ? $_[0]->{_result_source} = $_[1]
1305 # note this is a || not a ||=, the difference is important
1306 : $_[0]->{_result_source} || do {
1307 my $class = ref $_[0];
1308 $_[0]->can('result_source_instance')
1309 ? $_[0]->result_source_instance
1310 : $_[0]->throw_exception(
1311 "No result source instance registered for $class, did you forget to call $class->table(...) ?"
1317 =head2 register_column
1319 $column_info = { .... };
1320 $class->register_column($column_name, $column_info);
1324 =item Arguments: $columnname, \%columninfo
1326 =item Returns: undefined
1330 Registers a column on the class. If the column_info has an 'accessor'
1331 key, creates an accessor named after the value if defined; if there is
1332 no such key, creates an accessor with the same name as the column
1334 The column_info attributes are described in
1335 L<DBIx::Class::ResultSource/add_columns>
1339 sub register_column {
1340 my ($class, $col, $info) = @_;
1342 if (exists $info->{accessor}) {
1343 return unless defined $info->{accessor};
1344 $acc = [ $info->{accessor}, $col ];
1346 $class->mk_group_accessors('column' => $acc);
1349 =head2 get_from_storage
1351 my $copy = $row->get_from_storage($attrs)
1355 =item Arguments: \%attrs
1357 =item Returns: A Row object
1361 Fetches a fresh copy of the Row object from the database and returns it.
1362 Throws an exception if a proper WHERE clause identifying the database row
1363 can not be constructed (i.e. if the original object does not contain its
1365 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1366 ). If passed the \%attrs argument, will first apply these attributes to
1367 the resultset used to find the row.
1369 This copy can then be used to compare to an existing row object, to
1370 determine if any changes have been made in the database since it was
1373 To just update your Row object with any latest changes from the
1374 database, use L</discard_changes> instead.
1376 The \%attrs argument should be compatible with
1377 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1381 sub get_from_storage {
1382 my $self = shift @_;
1383 my $attrs = shift @_;
1384 my $resultset = $self->result_source->resultset;
1386 if(defined $attrs) {
1387 $resultset = $resultset->search(undef, $attrs);
1390 return $resultset->find($self->_storage_ident_condition);
1393 =head2 discard_changes ($attrs?)
1395 $row->discard_changes
1399 =item Arguments: none or $attrs
1401 =item Returns: self (updates object in-place)
1405 Re-selects the row from the database, losing any changes that had
1406 been made. Throws an exception if a proper C<WHERE> clause identifying
1407 the database row can not be constructed (i.e. if the original object
1408 does not contain its entire
1409 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>).
1411 This method can also be used to refresh from storage, retrieving any
1412 changes made since the row was last read from storage.
1414 $attrs, if supplied, is expected to be a hashref of attributes suitable for passing as the
1415 second argument to C<< $resultset->search($cond, $attrs) >>;
1417 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1418 storage, please kept in mind that if you L</discard_changes> on a row that you
1419 just updated or created, you should wrap the entire bit inside a transaction.
1420 Otherwise you run the risk that you insert or update to the master database
1421 but read from a replicant database that has not yet been updated from the
1422 master. This will result in unexpected results.
1426 sub discard_changes {
1427 my ($self, $attrs) = @_;
1428 return unless $self->in_storage; # Don't reload if we aren't real!
1430 # add a replication default to read from the master only
1431 $attrs = { force_pool => 'master', %{$attrs||{}} };
1433 if( my $current_storage = $self->get_from_storage($attrs)) {
1435 # Set $self to the current.
1436 %$self = %$current_storage;
1438 # Avoid a possible infinite loop with
1439 # sub DESTROY { $_[0]->discard_changes }
1440 bless $current_storage, 'Do::Not::Exist';
1445 $self->in_storage(0);
1451 =head2 throw_exception
1453 See L<DBIx::Class::Schema/throw_exception>.
1457 sub throw_exception {
1460 if (ref $self && ref $self->result_source ) {
1461 $self->result_source->throw_exception(@_)
1464 DBIx::Class::Exception->throw(@_);
1474 =item Arguments: none
1476 =item Returns: A list of primary key values
1480 Returns the primary key(s) for a row. Can't be called as a class method.
1481 Actually implemented in L<DBIx::Class::PK>
1485 Matt S. Trout <mst@shadowcatsystems.co.uk>
1489 You may distribute this code under the same terms as Perl itself.