1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
8 use Scalar::Util 'blessed';
9 use List::Util 'first';
11 use DBIx::Class::Carp;
12 use SQL::Abstract 'is_literal_value';
20 $ENV{DBIC_MULTICREATE_DEBUG}
27 __PACKAGE__->mk_group_accessors ( simple => [ in_storage => '_in_storage' ] );
31 DBIx::Class::Row - Basic row methods
37 This class is responsible for defining and doing basic operations on rows
38 derived from L<DBIx::Class::ResultSource> objects.
40 Result objects are returned from L<DBIx::Class::ResultSet>s using the
41 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
42 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
43 as well as invocations of 'single' (
44 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
45 L<has_one|DBIx::Class::Relationship/has_one> or
46 L<might_have|DBIx::Class::Relationship/might_have>)
47 relationship accessors of L<Result|DBIx::Class::Manual::ResultClass> objects.
51 All "Row objects" derived from a Schema-attached L<DBIx::Class::ResultSet>
52 object (such as a typical C<< L<search|DBIx::Class::ResultSet/search>->
53 L<next|DBIx::Class::ResultSet/next> >> call) are actually Result
54 instances, based on your application's
55 L<Result Class|DBIx::Class::Manual::Glossary/Result Class>.
57 L<DBIx::Class::Row> implements most of the row-based communication with the
58 underlying storage, but a Result class B<should not inherit from it directly>.
59 Usually, Result classes inherit from L<DBIx::Class::Core>, which in turn
60 combines the methods from several classes, one of them being
61 L<DBIx::Class::Row>. Therefore, while many of the methods available to a
62 L<DBIx::Class::Core>-derived Result class are described in the following
63 documentation, it does not detail all of the methods available to Result
64 objects. Refer to L<DBIx::Class::Manual::ResultClass> for more info.
70 my $result = My::Class->new(\%attrs);
72 my $result = $schema->resultset('MySource')->new(\%colsandvalues);
76 =item Arguments: \%attrs or \%colsandvalues
78 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
82 While you can create a new result object by calling C<new> directly on
83 this class, you are better off calling it on a
84 L<DBIx::Class::ResultSet> object.
86 When calling it directly, you will not get a complete, usable row
87 object until you pass or set the C<result_source> attribute, to a
88 L<DBIx::Class::ResultSource> instance that is attached to a
89 L<DBIx::Class::Schema> with a valid connection.
91 C<$attrs> is a hashref of column name, value data. It can also contain
92 some other attributes such as the C<result_source>.
94 Passing an object, or an arrayref of objects as a value will call
95 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
96 passed a hashref or an arrayref of hashrefs as the value, these will
97 be turned into objects via new_related, and treated as if you had
100 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
102 Please note that if a value is not passed to new, no value will be sent
103 in the SQL INSERT call, and the column will therefore assume whatever
104 default value was specified in your database. While DBIC will retrieve the
105 value of autoincrement columns, it will never make an explicit database
106 trip to retrieve default values assigned by the RDBMS. You can explicitly
107 request that all values be fetched back from the database by calling
108 L</discard_changes>, or you can supply an explicit C<undef> to columns
109 with NULL as the default, and save yourself a SELECT.
113 The behavior described above will backfire if you use a foreign key column
114 with a database-defined default. If you call the relationship accessor on
115 an object that doesn't have a set value for the FK column, DBIC will throw
116 an exception, as it has no way of knowing the PK of the related object (if
121 ## 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().
122 ## This only works because DBIC doesn't yet care to check whether the new_related objects have been passed all their mandatory columns
123 ## When doing the later insert, we need to make sure the PKs are set.
124 ## using _relationship_data in new and funky ways..
125 ## check Relationship::CascadeActions and Relationship::Accessor for compat
128 sub __new_related_find_or_new_helper {
129 my ($self, $rel_name, $values) = @_;
131 my $rsrc = $self->result_source;
133 # create a mock-object so all new/set_column component overrides will run:
134 my $rel_rs = $rsrc->related_source($rel_name)->resultset;
135 my $new_rel_obj = $rel_rs->new_result($values);
136 my $proc_data = { $new_rel_obj->get_columns };
138 if ($self->__their_pk_needs_us($rel_name)) {
139 MULTICREATE_DEBUG and print STDERR "MC $self constructing $rel_name via new_result\n";
142 elsif ($rsrc->_pk_depends_on($rel_name, $proc_data )) {
143 if (! keys %$proc_data) {
144 # there is nothing to search for - blind create
145 MULTICREATE_DEBUG and print STDERR "MC $self constructing default-insert $rel_name\n";
148 MULTICREATE_DEBUG and print STDERR "MC $self constructing $rel_name via find_or_new\n";
149 # this is not *really* find or new, as we don't want to double-new the
150 # data (thus potentially double encoding or whatever)
151 my $exists = $rel_rs->find ($proc_data);
152 return $exists if $exists;
157 my $us = $rsrc->source_name;
158 $self->throw_exception (
159 "Unable to determine relationship '$rel_name' direction from '$us', "
160 . "possibly due to a missing reverse-relationship on '$rel_name' to '$us'."
165 sub __their_pk_needs_us { # this should maybe be in resultsource.
166 my ($self, $rel_name) = @_;
167 my $rsrc = $self->result_source;
168 my $reverse = $rsrc->reverse_relationship_info($rel_name);
169 my $rel_source = $rsrc->related_source($rel_name);
170 my $us = { $self->get_columns };
171 foreach my $key (keys %$reverse) {
172 # if their primary key depends on us, then we have to
173 # just create a result and we'll fill it out afterwards
174 return 1 if $rel_source->_pk_depends_on($key, $us);
180 my ($class, $attrs) = @_;
181 $class = ref $class if ref $class;
183 my $new = bless { _column_data => {}, _in_storage => 0 }, $class;
186 $new->throw_exception("attrs must be a hashref")
187 unless ref($attrs) eq 'HASH';
189 my $rsrc = delete $attrs->{-result_source};
190 if ( my $h = delete $attrs->{-source_handle} ) {
191 $rsrc ||= $h->resolve;
194 $new->result_source($rsrc) if $rsrc;
196 if (my $col_from_rel = delete $attrs->{-cols_from_relations}) {
197 @{$new->{_ignore_at_insert}={}}{@$col_from_rel} = ();
200 my ($related,$inflated);
202 foreach my $key (keys %$attrs) {
203 if (ref $attrs->{$key} and ! is_literal_value($attrs->{$key}) ) {
204 ## Can we extract this lot to use with update(_or .. ) ?
205 $new->throw_exception("Can't do multi-create without result source")
207 my $info = $rsrc->relationship_info($key);
208 my $acc_type = $info->{attrs}{accessor} || '';
209 if ($acc_type eq 'single') {
210 my $rel_obj = delete $attrs->{$key};
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 $new->{_rel_in_storage}{$key} = 1;
217 $new->set_from_related($key, $rel_obj);
219 MULTICREATE_DEBUG and print STDERR "MC $new uninserted $key $rel_obj\n";
222 $related->{$key} = $rel_obj;
225 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
226 my $others = delete $attrs->{$key};
227 my $total = @$others;
229 foreach my $idx (0 .. $#$others) {
230 my $rel_obj = $others->[$idx];
231 if(!blessed $rel_obj) {
232 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
235 if ($rel_obj->in_storage) {
236 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
238 MULTICREATE_DEBUG and
239 print STDERR "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
241 push(@objects, $rel_obj);
243 $related->{$key} = \@objects;
246 elsif ($acc_type eq 'filter') {
247 ## 'filter' should disappear and get merged in with 'single' above!
248 my $rel_obj = delete $attrs->{$key};
249 if(!blessed $rel_obj) {
250 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
252 if ($rel_obj->in_storage) {
253 $new->{_rel_in_storage}{$key} = 1;
256 MULTICREATE_DEBUG and print STDERR "MC $new uninserted $key $rel_obj\n";
258 $inflated->{$key} = $rel_obj;
262 $rsrc->has_column($key)
264 $rsrc->column_info($key)->{_inflate_info}
266 $inflated->{$key} = $attrs->{$key};
270 $new->store_column($key => $attrs->{$key});
273 $new->{_relationship_data} = $related if $related;
274 $new->{_inflated_column} = $inflated if $inflated;
280 =head2 $column_accessor
282 # Each pair does the same thing
284 # (un-inflated, regular column)
285 my $val = $result->get_column('first_name');
286 my $val = $result->first_name;
288 $result->set_column('first_name' => $val);
289 $result->first_name($val);
291 # (inflated column via DBIx::Class::InflateColumn::DateTime)
292 my $val = $result->get_inflated_column('last_modified');
293 my $val = $result->last_modified;
295 $result->set_inflated_column('last_modified' => $val);
296 $result->last_modified($val);
300 =item Arguments: $value?
302 =item Return Value: $value
306 A column accessor method is created for each column, which is used for
307 getting/setting the value for that column.
309 The actual method name is based on the
310 L<accessor|DBIx::Class::ResultSource/accessor> name given during the
311 L<Result Class|DBIx::Class::Manual::ResultClass> L<column definition
312 |DBIx::Class::ResultSource/add_columns>. Like L</set_column>, this
313 will not store the data in the database until L</insert> or L</update>
314 is called on the row.
322 =item Arguments: none
324 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
328 Inserts an object previously created by L</new> into the database if
329 it isn't already in there. Returns the object itself. To insert an
330 entirely new row into the database, use L<DBIx::Class::ResultSet/create>.
332 To fetch an uninserted result object, call
333 L<new_result|DBIx::Class::ResultSet/new_result> on a resultset.
335 This will also insert any uninserted, related objects held inside this
336 one, see L<DBIx::Class::ResultSet/create> for more details.
342 return $self if $self->in_storage;
343 my $rsrc = $self->result_source;
344 $self->throw_exception("No result_source set on this object; can't insert")
347 my $storage = $rsrc->storage;
351 # Check if we stored uninserted relobjs here in new()
352 my %related_stuff = (%{$self->{_relationship_data} || {}},
353 %{$self->{_inflated_column} || {}});
355 # insert what needs to be inserted before us
357 for my $rel_name (keys %related_stuff) {
358 my $rel_obj = $related_stuff{$rel_name};
360 if (! $self->{_rel_in_storage}{$rel_name}) {
361 next unless (blessed $rel_obj && $rel_obj->isa('DBIx::Class::Row'));
363 next unless $rsrc->_pk_depends_on(
364 $rel_name, { $rel_obj->get_columns }
367 # The guard will save us if we blow out of this scope via die
368 $rollback_guard ||= $storage->txn_scope_guard;
370 MULTICREATE_DEBUG and print STDERR "MC $self pre-reconstructing $rel_name $rel_obj\n";
372 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_columns };
375 # if there are no keys - nothing to search for
376 if (keys %$them and $existing = $self->result_source
377 ->related_source($rel_name)
381 %{$rel_obj} = %{$existing};
387 $self->{_rel_in_storage}{$rel_name} = 1;
390 $self->set_from_related($rel_name, $rel_obj);
391 delete $related_stuff{$rel_name};
394 # start a transaction here if not started yet and there is more stuff
396 if (keys %related_stuff) {
397 $rollback_guard ||= $storage->txn_scope_guard
400 MULTICREATE_DEBUG and do {
401 no warnings 'uninitialized';
402 print STDERR "MC $self inserting (".join(', ', $self->get_columns).")\n";
405 # perform the insert - the storage will return everything it is asked to
406 # (autoinc primary columns and any retrieve_on_insert columns)
407 my %current_rowdata = $self->get_columns;
408 my $returned_cols = $storage->insert(
410 { %current_rowdata }, # what to insert, copy because the storage *will* change it
413 for (keys %$returned_cols) {
414 $self->store_column($_, $returned_cols->{$_})
415 # this ensures we fire store_column only once
416 # (some asshats like overriding it)
418 (!exists $current_rowdata{$_})
420 (defined $current_rowdata{$_} xor defined $returned_cols->{$_})
422 (defined $current_rowdata{$_} and $current_rowdata{$_} ne $returned_cols->{$_})
426 delete $self->{_column_data_in_storage};
427 $self->in_storage(1);
429 $self->{_dirty_columns} = {};
430 $self->{related_resultsets} = {};
432 foreach my $rel_name (keys %related_stuff) {
433 next unless $rsrc->has_relationship ($rel_name);
435 my @cands = ref $related_stuff{$rel_name} eq 'ARRAY'
436 ? @{$related_stuff{$rel_name}}
437 : $related_stuff{$rel_name}
440 if (@cands && blessed $cands[0] && $cands[0]->isa('DBIx::Class::Row')
442 my $reverse = $rsrc->reverse_relationship_info($rel_name);
443 foreach my $obj (@cands) {
444 $obj->set_from_related($_, $self) for keys %$reverse;
445 if ($self->__their_pk_needs_us($rel_name)) {
446 if (exists $self->{_ignore_at_insert}{$rel_name}) {
447 MULTICREATE_DEBUG and print STDERR "MC $self skipping post-insert on $rel_name\n";
450 MULTICREATE_DEBUG and print STDERR "MC $self inserting $rel_name $obj\n";
454 MULTICREATE_DEBUG and print STDERR "MC $self post-inserting $obj\n";
461 delete $self->{_ignore_at_insert};
463 $rollback_guard->commit if $rollback_guard;
470 $result->in_storage; # Get value
471 $result->in_storage(1); # Set value
475 =item Arguments: none or 1|0
477 =item Return Value: 1|0
481 Indicates whether the object exists as a row in the database or
482 not. This is set to true when L<DBIx::Class::ResultSet/find>,
483 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::Row/insert>
486 Creating a result object using L<DBIx::Class::ResultSet/new_result>, or
487 calling L</delete> on one, sets it to false.
492 $result->update(\%columns?)
496 =item Arguments: none or a hashref
498 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
502 Throws an exception if the result object is not yet in the database,
503 according to L</in_storage>. Returns the object itself.
505 This method issues an SQL UPDATE query to commit any changes to the
506 object to the database if required (see L</get_dirty_columns>).
507 It throws an exception if a proper WHERE clause uniquely identifying
508 the database row can not be constructed (see
509 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
512 Also takes an optional hashref of C<< column_name => value >> pairs
513 to update on the object first. Be aware that the hashref will be
514 passed to C<set_inflated_columns>, which might edit it in place, so
515 don't rely on it being the same after a call to C<update>. If you
516 need to preserve the hashref, it is sufficient to pass a shallow copy
517 to C<update>, e.g. ( { %{ $href } } )
519 If the values passed or any of the column values set on the object
520 contain scalar references, e.g.:
522 $result->last_modified(\'NOW()')->update();
524 $result->update({ last_modified => \'NOW()' });
526 The update will pass the values verbatim into SQL. (See
527 L<SQL::Abstract> docs). The values in your Result object will NOT change
528 as a result of the update call, if you want the object to be updated
529 with the actual values from the database, call L</discard_changes>
532 $result->update()->discard_changes();
534 To determine before calling this method, which column values have
535 changed and will be updated, call L</get_dirty_columns>.
537 To check if any columns will be updated, call L</is_changed>.
539 To force a column to be updated, call L</make_column_dirty> before
545 my ($self, $upd) = @_;
547 $self->set_inflated_columns($upd) if $upd;
549 my %to_update = $self->get_dirty_columns
552 $self->throw_exception( "Not in database" ) unless $self->in_storage;
554 my $rows = $self->result_source->storage->update(
555 $self->result_source, \%to_update, $self->_storage_ident_condition
558 $self->throw_exception( "Can't update ${self}: row not found" );
559 } elsif ($rows > 1) {
560 $self->throw_exception("Can't update ${self}: updated more than one row");
562 $self->{_dirty_columns} = {};
563 $self->{related_resultsets} = {};
564 delete $self->{_column_data_in_storage};
574 =item Arguments: none
576 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
580 Throws an exception if the object is not in the database according to
581 L</in_storage>. Also throws an exception if a proper WHERE clause
582 uniquely identifying the database row can not be constructed (see
583 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
586 The object is still perfectly usable, but L</in_storage> will
587 now return 0 and the object must be reinserted using L</insert>
588 before it can be used to L</update> the row again.
590 If you delete an object in a class with a C<has_many> relationship, an
591 attempt is made to delete all the related objects as well. To turn
592 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
593 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
594 database-level cascade or restrict will take precedence over a
595 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
596 main row first> and only then attempts to delete any remaining related
599 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
600 and the transaction subsequently fails, the result object will remain marked as
601 not being in storage. If you know for a fact that the object is still in
602 storage (i.e. by inspecting the cause of the transaction's failure), you can
603 use C<< $obj->in_storage(1) >> to restore consistency between the object and
604 the database. This would allow a subsequent C<< $obj->delete >> to work
607 See also L<DBIx::Class::ResultSet/delete>.
614 $self->throw_exception( "Not in database" ) unless $self->in_storage;
616 $self->result_source->storage->delete(
617 $self->result_source, $self->_storage_ident_condition
620 delete $self->{_column_data_in_storage};
621 $self->in_storage(0);
624 my $rsrc = try { $self->result_source_instance }
625 or $self->throw_exception("Can't do class delete without a ResultSource instance");
627 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
628 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
629 $rsrc->resultset->search(@_)->delete;
636 my $val = $result->get_column($col);
640 =item Arguments: $columnname
642 =item Return Value: The value of the column
646 Throws an exception if the column name given doesn't exist according
647 to L<has_column|DBIx::Class::ResultSource/has_column>.
649 Returns a raw column value from the result object, if it has already
650 been fetched from the database or set by an accessor.
652 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
653 will be deflated and returned.
655 Note that if you used the C<columns> or the C<select/as>
656 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
657 which C<$result> was derived, and B<did not include> C<$columnname> in the list,
658 this method will return C<undef> even if the database contains some value.
660 To retrieve all loaded column values as a hash, use L</get_columns>.
665 my ($self, $column) = @_;
666 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
668 return $self->{_column_data}{$column}
669 if exists $self->{_column_data}{$column};
671 if (exists $self->{_inflated_column}{$column}) {
672 # deflate+return cycle
673 return $self->store_column($column, $self->_deflated_column(
674 $column, $self->{_inflated_column}{$column}
678 $self->throw_exception( "No such column '${column}' on " . ref $self )
679 unless $self->result_source->has_column($column);
684 =head2 has_column_loaded
686 if ( $result->has_column_loaded($col) ) {
687 print "$col has been loaded from db";
692 =item Arguments: $columnname
694 =item Return Value: 0|1
698 Returns a true value if the column value has been loaded from the
699 database (or set locally).
703 sub has_column_loaded {
704 my ($self, $column) = @_;
705 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
708 exists $self->{_inflated_column}{$column}
710 exists $self->{_column_data}{$column}
714 sub _has_related_resultset_cached {
715 my ($self, $relname) = @_;
717 my $accessor = ($self->relationship_info($relname) || {})->{attrs}{accessor} || '';
720 $accessor eq 'single'
722 exists $self->{_relationship_data}{$relname}
724 $accessor eq 'filter'
726 exists $self->{_inflated_column}{$relname}
728 defined $self->{related_resultsets}{$relname}
730 defined $self->{related_resultsets}{$relname}->get_cache
736 my %data = $result->get_columns;
740 =item Arguments: none
742 =item Return Value: A hash of columnname, value pairs.
746 Returns all loaded column data as a hash, containing raw values. To
747 get just one value for a particular column, use L</get_column>.
749 See L</get_inflated_columns> to get the inflated values.
755 if (exists $self->{_inflated_column}) {
756 # deflate cycle for each inflation, including filter rels
757 foreach my $col (keys %{$self->{_inflated_column}}) {
758 unless (exists $self->{_column_data}{$col}) {
760 # if cached related_resultset is present assume this was a prefetch
762 "Returning primary keys of prefetched 'filter' rels as part of get_columns() is deprecated and will "
763 . 'eventually be removed entirely (set DBIC_COLUMNS_INCLUDE_FILTER_RELS to disable this warning)'
765 ! $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS}
767 $self->_has_related_resultset_cached($col)
770 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}));
774 return %{$self->{_column_data}};
777 =head2 get_dirty_columns
779 my %data = $result->get_dirty_columns;
783 =item Arguments: none
785 =item Return Value: A hash of column, value pairs
789 Only returns the column, value pairs for those columns that have been
790 changed on this object since the last L</update> or L</insert> call.
792 See L</get_columns> to fetch all column/value pairs.
796 sub get_dirty_columns {
798 return map { $_ => $self->{_column_data}{$_} }
799 keys %{$self->{_dirty_columns}};
802 =head2 make_column_dirty
804 $result->make_column_dirty($col)
808 =item Arguments: $columnname
810 =item Return Value: not defined
814 Throws an exception if the column does not exist.
816 Marks a column as having been changed regardless of whether it has
821 sub make_column_dirty {
822 my ($self, $column) = @_;
824 $self->throw_exception( "No such column '${column}' on " . ref $self )
825 unless exists $self->{_column_data}{$column} || $self->result_source->has_column($column);
827 # the entire clean/dirty code relies on exists, not on true/false
828 return 1 if exists $self->{_dirty_columns}{$column};
830 $self->{_dirty_columns}{$column} = 1;
832 # if we are just now making the column dirty, and if there is an inflated
833 # value, force it over the deflated one
834 if (exists $self->{_inflated_column}{$column}) {
835 $self->store_column($column,
836 $self->_deflated_column(
837 $column, $self->{_inflated_column}{$column}
843 =head2 get_inflated_columns
845 my %inflated_data = $obj->get_inflated_columns;
849 =item Arguments: none
851 =item Return Value: A hash of column, object|value pairs
855 Returns a hash of all column keys and associated values. Values for any
856 columns set to use inflation will be inflated and returns as objects.
858 See L</get_columns> to get the uninflated values.
860 See L<DBIx::Class::InflateColumn> for how to setup inflation.
864 sub get_inflated_columns {
867 my $loaded_colinfo = $self->result_source->columns_info;
868 $self->has_column_loaded($_) or delete $loaded_colinfo->{$_}
869 for keys %$loaded_colinfo;
871 my %cols_to_return = ( %{$self->{_column_data}}, %$loaded_colinfo );
873 unless ($ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS}) {
874 for (keys %$loaded_colinfo) {
875 # if cached related_resultset is present assume this was a prefetch
877 $loaded_colinfo->{$_}{_inflate_info}
879 $self->_has_related_resultset_cached($_)
882 "Returning prefetched 'filter' rels as part of get_inflated_columns() is deprecated and will "
883 . 'eventually be removed entirely (set DBIC_COLUMNS_INCLUDE_FILTER_RELS to disable this warning)'
892 ! exists $loaded_colinfo->{$_}
895 exists $loaded_colinfo->{$_}{accessor}
897 ! defined $loaded_colinfo->{$_}{accessor}
899 ) ? $self->get_column($_)
901 defined $loaded_colinfo->{$_}{accessor}
902 ? $loaded_colinfo->{$_}{accessor}
905 )} keys %cols_to_return;
908 sub _is_column_numeric {
909 my ($self, $column) = @_;
911 return undef unless $self->result_source->has_column($column);
913 my $colinfo = $self->result_source->column_info ($column);
915 # cache for speed (the object may *not* have a resultsource instance)
917 ! defined $colinfo->{is_numeric}
919 my $storage = try { $self->result_source->schema->storage }
921 $colinfo->{is_numeric} =
922 $storage->is_datatype_numeric ($colinfo->{data_type})
928 return $colinfo->{is_numeric};
933 $result->set_column($col => $val);
937 =item Arguments: $columnname, $value
939 =item Return Value: $value
943 Sets a raw column value. If the new value is different from the old one,
944 the column is marked as dirty for when you next call L</update>.
946 If passed an object or reference as a value, this method will happily
947 attempt to store it, and a later L</insert> or L</update> will try and
948 stringify/numify as appropriate. To set an object to be deflated
949 instead, see L</set_inflated_columns>, or better yet, use L</$column_accessor>.
954 my ($self, $column, $new_value) = @_;
956 my $had_value = $self->has_column_loaded($column);
957 my $old_value = $self->get_column($column);
959 $new_value = $self->store_column($column, $new_value);
962 $self->{_dirty_columns}{$column}
964 ( $self->in_storage # no point tracking dirtyness on uninserted data
965 ? ! $self->_eq_column_values ($column, $old_value, $new_value)
971 # FIXME sadly the update code just checks for keys, not for their value
972 $self->{_dirty_columns}{$column} = 1;
974 # Clear out the relation/inflation cache related to this column
976 # FIXME - this is a quick *largely incorrect* hack, pending a more
977 # serious rework during the merge of single and filter rels
978 my $rel_names = $self->result_source->{_relationships};
979 for my $rel_name (keys %$rel_names) {
981 my $acc = $rel_names->{$rel_name}{attrs}{accessor} || '';
983 if ( $acc eq 'single' and $rel_names->{$rel_name}{attrs}{fk_columns}{$column} ) {
984 delete $self->{related_resultsets}{$rel_name};
985 delete $self->{_relationship_data}{$rel_name};
986 #delete $self->{_inflated_column}{$rel_name};
988 elsif ( $acc eq 'filter' and $rel_name eq $column) {
989 delete $self->{related_resultsets}{$rel_name};
990 #delete $self->{_relationship_data}{$rel_name};
991 delete $self->{_inflated_column}{$rel_name};
996 # value change from something (even if NULL)
999 # no storage - no storage-value
1002 # no value already stored (multiple changes before commit to storage)
1003 ! exists $self->{_column_data_in_storage}{$column}
1005 $self->_track_storage_value($column)
1007 $self->{_column_data_in_storage}{$column} = $old_value;
1014 sub _eq_column_values {
1015 my ($self, $col, $old, $new) = @_;
1017 if (defined $old xor defined $new) {
1020 elsif (not defined $old) { # both undef
1024 is_literal_value $old
1026 is_literal_value $new
1030 elsif ($old eq $new) {
1033 elsif ($self->_is_column_numeric($col)) { # do a numeric comparison if datatype allows it
1034 return $old == $new;
1041 # returns a boolean indicating if the passed column should have its original
1042 # value tracked between column changes and commitment to storage
1043 sub _track_storage_value {
1044 my ($self, $col) = @_;
1045 return defined first { $col eq $_ } ($self->result_source->primary_columns);
1050 $result->set_columns({ $col => $val, ... });
1054 =item Arguments: \%columndata
1056 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1060 Sets multiple column, raw value pairs at once.
1062 Works as L</set_column>.
1067 my ($self, $values) = @_;
1068 $self->set_column( $_, $values->{$_} ) for keys %$values;
1072 =head2 set_inflated_columns
1074 $result->set_inflated_columns({ $col => $val, $rel_name => $obj, ... });
1078 =item Arguments: \%columndata
1080 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1084 Sets more than one column value at once. Any inflated values are
1085 deflated and the raw values stored.
1087 Any related values passed as Result objects, using the relation name as a
1088 key, are reduced to the appropriate foreign key values and stored. If
1089 instead of related result objects, a hashref of column, value data is
1090 passed, will create the related object first then store.
1092 Will even accept arrayrefs of data as a value to a
1093 L<DBIx::Class::Relationship/has_many> key, and create the related
1094 objects if necessary.
1096 Be aware that the input hashref might be edited in place, so don't rely
1097 on it being the same after a call to C<set_inflated_columns>. If you
1098 need to preserve the hashref, it is sufficient to pass a shallow copy
1099 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
1101 See also L<DBIx::Class::Relationship::Base/set_from_related>.
1105 sub set_inflated_columns {
1106 my ( $self, $upd ) = @_;
1108 foreach my $key (keys %$upd) {
1109 if (ref $upd->{$key}) {
1110 $rsrc ||= $self->result_source;
1111 my $info = $rsrc->relationship_info($key);
1112 my $acc_type = $info->{attrs}{accessor} || '';
1114 if ($acc_type eq 'single') {
1115 my $rel_obj = delete $upd->{$key};
1116 $self->set_from_related($key => $rel_obj);
1117 $self->{_relationship_data}{$key} = $rel_obj;
1119 elsif ($acc_type eq 'multi') {
1120 $self->throw_exception(
1121 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
1125 $rsrc->has_column($key)
1127 exists $rsrc->column_info($key)->{_inflate_info}
1129 $self->set_inflated_column($key, delete $upd->{$key});
1133 $self->set_columns($upd);
1138 my $copy = $orig->copy({ change => $to, ... });
1142 =item Arguments: \%replacementdata
1144 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> copy
1148 Inserts a new row into the database, as a copy of the original
1149 object. If a hashref of replacement data is supplied, these will take
1150 precedence over data in the original. Also any columns which have
1151 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
1152 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
1153 so that the database can insert its own autoincremented values into
1156 Relationships will be followed by the copy procedure B<only> if the
1157 relationship specifies a true value for its
1158 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1159 is set by default on C<has_many> relationships and unset on all others.
1164 my ($self, $changes) = @_;
1166 my $col_data = { $self->get_columns };
1168 my $rsrc = $self->result_source;
1170 my $colinfo = $rsrc->columns_info;
1171 foreach my $col (keys %$col_data) {
1172 delete $col_data->{$col}
1173 if ( ! $colinfo->{$col} or $colinfo->{$col}{is_auto_increment} );
1176 my $new = { _column_data => $col_data };
1177 bless $new, ref $self;
1179 $new->result_source($rsrc);
1180 $new->set_inflated_columns($changes);
1183 # Its possible we'll have 2 relations to the same Source. We need to make
1184 # sure we don't try to insert the same row twice else we'll violate unique
1186 my $rel_names_copied = {};
1188 foreach my $rel_name ($rsrc->relationships) {
1189 my $rel_info = $rsrc->relationship_info($rel_name);
1191 next unless $rel_info->{attrs}{cascade_copy};
1193 my $resolved = $rsrc->_resolve_condition(
1194 $rel_info->{cond}, $rel_name, $new, $rel_name
1197 my $copied = $rel_names_copied->{ $rel_info->{source} } ||= {};
1198 foreach my $related ($self->search_related($rel_name)->all) {
1199 $related->copy($resolved)
1200 unless $copied->{$related->ID}++;
1209 $result->store_column($col => $val);
1213 =item Arguments: $columnname, $value
1215 =item Return Value: The value sent to storage
1219 Set a raw value for a column without marking it as changed. This
1220 method is used internally by L</set_column> which you should probably
1223 This is the lowest level at which data is set on a result object,
1224 extend this method to catch all data setting methods.
1229 my ($self, $column, $value) = @_;
1230 $self->throw_exception( "No such column '${column}' on " . ref $self )
1231 unless exists $self->{_column_data}{$column} || $self->result_source->has_column($column);
1232 $self->throw_exception( "set_column called for ${column} without value" )
1234 return $self->{_column_data}{$column} = $value;
1237 =head2 inflate_result
1239 Class->inflate_result($result_source, \%me, \%prefetch?)
1243 =item Arguments: L<$result_source|DBIx::Class::ResultSource>, \%columndata, \%prefetcheddata
1245 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1249 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1250 database and turn it into result objects call this method.
1252 Extend this method in your Result classes to hook into this process,
1253 for example to rebless the result into a different class.
1255 Reblessing can also be done more easily by setting C<result_class> in
1256 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1258 Different types of results can also be created from a particular
1259 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1263 sub inflate_result {
1264 my ($class, $rsrc, $me, $prefetch) = @_;
1266 # XXX: WTF is $me sometimes undef?
1268 { _column_data => $me || {}, _result_source => $rsrc },
1269 ref $class || $class
1273 for my $rel_name ( keys %$prefetch ) {
1275 my $relinfo = $rsrc->relationship_info($rel_name) or do {
1277 "Inflation into non-existent relationship '%s' of '%s' requested",
1281 if (my ($colname) = sort { length($a) <=> length ($b) } keys %{$prefetch->{$rel_name}[0] || {}} ) {
1282 $err .= sprintf ", check the inflation specification (columns/as) ending in '...%s.%s'",
1287 $rsrc->throw_exception($err);
1290 $class->throw_exception("No accessor type declared for prefetched relationship '$rel_name'")
1291 unless $relinfo->{attrs}{accessor};
1293 my $rel_rsrc = $rsrc->related_source($rel_name);
1297 @{ $prefetch->{$rel_name} || [] }
1299 ref($prefetch->{$rel_name}) ne $DBIx::Class::ResultSource::RowParser::Util::null_branch_class
1302 if (ref $prefetch->{$rel_name}[0] eq 'ARRAY') {
1303 my $rel_class = $rel_rsrc->result_class;
1304 my $rel_inflator = $rel_class->can('inflate_result');
1306 { $rel_class->$rel_inflator ( $rel_rsrc, @$_ ) }
1307 @{$prefetch->{$rel_name}}
1311 @rel_objects = $rel_rsrc->result_class->inflate_result(
1312 $rel_rsrc, @{$prefetch->{$rel_name}}
1317 if ($relinfo->{attrs}{accessor} eq 'single') {
1318 $new->{_relationship_data}{$rel_name} = $rel_objects[0];
1320 elsif ($relinfo->{attrs}{accessor} eq 'filter') {
1321 $new->{_inflated_column}{$rel_name} = $rel_objects[0];
1324 $new->related_resultset($rel_name)->set_cache(\@rel_objects);
1329 $new->in_storage (1);
1333 =head2 update_or_insert
1335 $result->update_or_insert
1339 =item Arguments: none
1341 =item Return Value: Result of update or insert operation
1345 L</update>s the object if it's already in the database, according to
1346 L</in_storage>, else L</insert>s it.
1348 =head2 insert_or_update
1350 $obj->insert_or_update
1352 Alias for L</update_or_insert>
1356 sub insert_or_update { shift->update_or_insert(@_) }
1358 sub update_or_insert {
1360 return ($self->in_storage ? $self->update : $self->insert);
1365 my @changed_col_names = $result->is_changed();
1366 if ($result->is_changed()) { ... }
1370 =item Arguments: none
1372 =item Return Value: 0|1 or @columnnames
1376 In list context returns a list of columns with uncommited changes, or
1377 in scalar context returns a true value if there are uncommitted
1383 return keys %{shift->{_dirty_columns} || {}};
1386 =head2 is_column_changed
1388 if ($result->is_column_changed('col')) { ... }
1392 =item Arguments: $columname
1394 =item Return Value: 0|1
1398 Returns a true value if the column has uncommitted changes.
1402 sub is_column_changed {
1403 my( $self, $col ) = @_;
1404 return exists $self->{_dirty_columns}->{$col};
1407 =head2 result_source
1409 my $resultsource = $result->result_source;
1413 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1415 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1419 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1424 $_[0]->throw_exception( 'result_source can be called on instances only' )
1428 ? $_[0]->{_result_source} = $_[1]
1430 # note this is a || not a ||=, the difference is important
1431 : $_[0]->{_result_source} || do {
1432 my $class = ref $_[0];
1433 $_[0]->can('result_source_instance')
1434 ? $_[0]->result_source_instance
1435 : $_[0]->throw_exception(
1436 "No result source instance registered for $class, did you forget to call $class->table(...) ?"
1442 =head2 register_column
1444 $column_info = { .... };
1445 $class->register_column($column_name, $column_info);
1449 =item Arguments: $columnname, \%columninfo
1451 =item Return Value: not defined
1455 Registers a column on the class. If the column_info has an 'accessor'
1456 key, creates an accessor named after the value if defined; if there is
1457 no such key, creates an accessor with the same name as the column
1459 The column_info attributes are described in
1460 L<DBIx::Class::ResultSource/add_columns>
1464 sub register_column {
1465 my ($class, $col, $info) = @_;
1467 if (exists $info->{accessor}) {
1468 return unless defined $info->{accessor};
1469 $acc = [ $info->{accessor}, $col ];
1471 $class->mk_group_accessors('column' => $acc);
1474 =head2 get_from_storage
1476 my $copy = $result->get_from_storage($attrs)
1480 =item Arguments: \%attrs
1482 =item Return Value: A Result object
1486 Fetches a fresh copy of the Result object from the database and returns it.
1487 Throws an exception if a proper WHERE clause identifying the database row
1488 can not be constructed (i.e. if the original object does not contain its
1490 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1491 ). If passed the \%attrs argument, will first apply these attributes to
1492 the resultset used to find the row.
1494 This copy can then be used to compare to an existing result object, to
1495 determine if any changes have been made in the database since it was
1498 To just update your Result object with any latest changes from the
1499 database, use L</discard_changes> instead.
1501 The \%attrs argument should be compatible with
1502 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1506 sub get_from_storage {
1507 my $self = shift @_;
1508 my $attrs = shift @_;
1509 my $resultset = $self->result_source->resultset;
1511 if(defined $attrs) {
1512 $resultset = $resultset->search(undef, $attrs);
1515 return $resultset->find($self->_storage_ident_condition);
1518 =head2 discard_changes
1520 $result->discard_changes
1524 =item Arguments: none or $attrs
1526 =item Return Value: self (updates object in-place)
1530 Re-selects the row from the database, losing any changes that had
1531 been made. Throws an exception if a proper C<WHERE> clause identifying
1532 the database row can not be constructed (i.e. if the original object
1533 does not contain its entire
1534 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>).
1536 This method can also be used to refresh from storage, retrieving any
1537 changes made since the row was last read from storage.
1539 $attrs, if supplied, is expected to be a hashref of attributes suitable for passing as the
1540 second argument to C<< $resultset->search($cond, $attrs) >>;
1542 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1543 storage, a default of
1544 L<< C<< { force_pool => 'master' } >>
1545 |DBIx::Class::Storage::DBI::Replicated/SYNOPSIS >> is automatically set for
1546 you. Prior to C<< DBIx::Class 0.08109 >> (before 2010) one would have been
1547 required to explicitly wrap the entire operation in a transaction to guarantee
1548 that up-to-date results are read from the master database.
1552 sub discard_changes {
1553 my ($self, $attrs) = @_;
1554 return unless $self->in_storage; # Don't reload if we aren't real!
1556 # add a replication default to read from the master only
1557 $attrs = { force_pool => 'master', %{$attrs||{}} };
1559 if( my $current_storage = $self->get_from_storage($attrs)) {
1561 # Set $self to the current.
1562 %$self = %$current_storage;
1564 # Avoid a possible infinite loop with
1565 # sub DESTROY { $_[0]->discard_changes }
1566 bless $current_storage, 'Do::Not::Exist';
1571 $self->in_storage(0);
1576 =head2 throw_exception
1578 See L<DBIx::Class::Schema/throw_exception>.
1582 sub throw_exception {
1585 if (ref $self && ref $self->result_source ) {
1586 $self->result_source->throw_exception(@_)
1589 DBIx::Class::Exception->throw(@_);
1595 my @pk = $result->id;
1599 =item Arguments: none
1601 =item Returns: A list of primary key values
1605 Returns the primary key(s) for a row. Can't be called as a class method.
1606 Actually implemented in L<DBIx::Class::PK>
1608 =head1 FURTHER QUESTIONS?
1610 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
1612 =head1 COPYRIGHT AND LICENSE
1614 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
1615 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
1616 redistribute it and/or modify it under the same terms as the
1617 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.