1 package DBIx::Class::Row;
6 use base qw/DBIx::Class/;
8 use Scalar::Util 'blessed';
9 use DBIx::Class::_Util qw(
10 dbic_internal_try fail_on_internal_call
13 use DBIx::Class::Carp;
14 use SQL::Abstract qw( is_literal_value is_plain_value );
22 $ENV{DBIC_MULTICREATE_DEBUG}
29 __PACKAGE__->mk_group_accessors ( simple => [ in_storage => '_in_storage' ] );
33 DBIx::Class::Row - Basic row methods
39 This class is responsible for defining and doing basic operations on rows
40 derived from L<DBIx::Class::ResultSource> objects.
42 Result objects are returned from L<DBIx::Class::ResultSet>s using the
43 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
44 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
45 as well as invocations of 'single' (
46 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
47 L<has_one|DBIx::Class::Relationship/has_one> or
48 L<might_have|DBIx::Class::Relationship/might_have>)
49 relationship accessors of L<Result|DBIx::Class::Manual::ResultClass> objects.
53 All "Row objects" derived from a Schema-attached L<DBIx::Class::ResultSet>
54 object (such as a typical C<< L<search|DBIx::Class::ResultSet/search>->
55 L<next|DBIx::Class::ResultSet/next> >> call) are actually Result
56 instances, based on your application's
57 L<Result Class|DBIx::Class::Manual::Glossary/Result Class>.
59 L<DBIx::Class::Row> implements most of the row-based communication with the
60 underlying storage, but a Result class B<should not inherit from it directly>.
61 Usually, Result classes inherit from L<DBIx::Class::Core>, which in turn
62 combines the methods from several classes, one of them being
63 L<DBIx::Class::Row>. Therefore, while many of the methods available to a
64 L<DBIx::Class::Core>-derived Result class are described in the following
65 documentation, it does not detail all of the methods available to Result
66 objects. Refer to L<DBIx::Class::Manual::ResultClass> for more info.
72 my $result = My::Class->new(\%attrs);
74 my $result = $schema->resultset('MySource')->new(\%colsandvalues);
78 =item Arguments: \%attrs or \%colsandvalues
80 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
84 While you can create a new result object by calling C<new> directly on
85 this class, you are better off calling it on a
86 L<DBIx::Class::ResultSet> object.
88 When calling it directly, you will not get a complete, usable row
89 object until you pass or set the C<result_source> attribute, to a
90 L<DBIx::Class::ResultSource> instance that is attached to a
91 L<DBIx::Class::Schema> with a valid connection.
93 C<$attrs> is a hashref of column name, value data. It can also contain
94 some other attributes such as the C<result_source>.
96 Passing an object, or an arrayref of objects as a value will call
97 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
98 passed a hashref or an arrayref of hashrefs as the value, these will
99 be turned into objects via new_related, and treated as if you had
102 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
104 Please note that if a value is not passed to new, no value will be sent
105 in the SQL INSERT call, and the column will therefore assume whatever
106 default value was specified in your database. While DBIC will retrieve the
107 value of autoincrement columns, it will never make an explicit database
108 trip to retrieve default values assigned by the RDBMS. You can explicitly
109 request that all values be fetched back from the database by calling
110 L</discard_changes>, or you can supply an explicit C<undef> to columns
111 with NULL as the default, and save yourself a SELECT.
115 The behavior described above will backfire if you use a foreign key column
116 with a database-defined default. If you call the relationship accessor on
117 an object that doesn't have a set value for the FK column, DBIC will throw
118 an exception, as it has no way of knowing the PK of the related object (if
123 ## 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().
124 ## This only works because DBIC doesn't yet care to check whether the new_related objects have been passed all their mandatory columns
125 ## When doing the later insert, we need to make sure the PKs are set.
126 ## using _relationship_data in new and funky ways..
127 ## check Relationship::CascadeActions and Relationship::Accessor for compat
130 sub __new_related_find_or_new_helper {
131 my ($self, $rel_name, $values) = @_;
133 my $rsrc = $self->result_source;
135 # create a mock-object so all new/set_column component overrides will run:
136 my $rel_rs = $rsrc->related_source($rel_name)->resultset;
137 my $new_rel_obj = $rel_rs->new_result($values);
138 my $proc_data = { $new_rel_obj->get_columns };
140 if ($self->__their_pk_needs_us($rel_name)) {
141 MULTICREATE_DEBUG and print STDERR "MC $self constructing $rel_name via new_result\n";
144 elsif ($rsrc->_pk_depends_on($rel_name, $proc_data )) {
145 if (! keys %$proc_data) {
146 # there is nothing to search for - blind create
147 MULTICREATE_DEBUG and print STDERR "MC $self constructing default-insert $rel_name\n";
150 MULTICREATE_DEBUG and print STDERR "MC $self constructing $rel_name via find_or_new\n";
151 # this is not *really* find or new, as we don't want to double-new the
152 # data (thus potentially double encoding or whatever)
153 my $exists = $rel_rs->find ($proc_data);
154 return $exists if $exists;
159 my $us = $rsrc->source_name;
160 $self->throw_exception (
161 "Unable to determine relationship '$rel_name' direction from '$us', "
162 . "possibly due to a missing reverse-relationship on '$rel_name' to '$us'."
167 sub __their_pk_needs_us { # this should maybe be in resultsource.
168 my ($self, $rel_name) = @_;
169 my $rsrc = $self->result_source;
170 my $reverse = $rsrc->reverse_relationship_info($rel_name);
171 my $rel_source = $rsrc->related_source($rel_name);
172 my $us = { $self->get_columns };
173 foreach my $key (keys %$reverse) {
174 # if their primary key depends on us, then we have to
175 # just create a result and we'll fill it out afterwards
176 return 1 if $rel_source->_pk_depends_on($key, $us);
182 my ($class, $attrs) = @_;
183 $class = ref $class if ref $class;
185 my $new = bless { _column_data => {}, _in_storage => 0 }, $class;
188 $new->throw_exception("attrs must be a hashref")
189 unless ref($attrs) eq 'HASH';
191 my $rsrc = delete $attrs->{-result_source};
192 if ( my $h = delete $attrs->{-source_handle} ) {
193 $rsrc ||= $h->resolve;
196 $new->result_source_instance($rsrc) if $rsrc;
198 if (my $col_from_rel = delete $attrs->{-cols_from_relations}) {
199 @{$new->{_ignore_at_insert}={}}{@$col_from_rel} = ();
202 my( $related, $inflated, $colinfos );
204 foreach my $key (keys %$attrs) {
205 if (ref $attrs->{$key} and ! is_literal_value($attrs->{$key}) ) {
206 ## Can we extract this lot to use with update(_or .. ) ?
207 $new->throw_exception("Can't do multi-create without result source")
209 my $info = $rsrc->relationship_info($key);
210 my $acc_type = $info->{attrs}{accessor} || '';
211 if ($acc_type eq 'single') {
212 my $rel_obj = delete $attrs->{$key};
213 if(!blessed $rel_obj) {
214 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
217 if ($rel_obj->in_storage) {
218 $new->{_rel_in_storage}{$key} = 1;
219 $new->set_from_related($key, $rel_obj);
221 MULTICREATE_DEBUG and print STDERR "MC $new uninserted $key $rel_obj\n";
224 $related->{$key} = $rel_obj;
227 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
228 my $others = delete $attrs->{$key};
229 my $total = @$others;
231 foreach my $idx (0 .. $#$others) {
232 my $rel_obj = $others->[$idx];
233 if(!blessed $rel_obj) {
234 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
237 if ($rel_obj->in_storage) {
238 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
240 MULTICREATE_DEBUG and
241 print STDERR "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
243 push(@objects, $rel_obj);
245 $related->{$key} = \@objects;
248 elsif ($acc_type eq 'filter') {
249 ## 'filter' should disappear and get merged in with 'single' above!
250 my $rel_obj = delete $attrs->{$key};
251 if(!blessed $rel_obj) {
252 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
254 if ($rel_obj->in_storage) {
255 $new->{_rel_in_storage}{$key} = 1;
258 MULTICREATE_DEBUG and print STDERR "MC $new uninserted $key $rel_obj\n";
260 $inflated->{$key} = $rel_obj;
264 ( $colinfos ||= $rsrc->columns_info )
265 ->{$key}{_inflate_info}
267 $inflated->{$key} = $attrs->{$key};
271 $new->store_column($key => $attrs->{$key});
274 $new->{_relationship_data} = $related if $related;
275 $new->{_inflated_column} = $inflated if $inflated;
281 =head2 $column_accessor
283 # Each pair does the same thing
285 # (un-inflated, regular column)
286 my $val = $result->get_column('first_name');
287 my $val = $result->first_name;
289 $result->set_column('first_name' => $val);
290 $result->first_name($val);
292 # (inflated column via DBIx::Class::InflateColumn::DateTime)
293 my $val = $result->get_inflated_column('last_modified');
294 my $val = $result->last_modified;
296 $result->set_inflated_column('last_modified' => $val);
297 $result->last_modified($val);
301 =item Arguments: $value?
303 =item Return Value: $value
307 A column accessor method is created for each column, which is used for
308 getting/setting the value for that column.
310 The actual method name is based on the
311 L<accessor|DBIx::Class::ResultSource/accessor> name given during the
312 L<Result Class|DBIx::Class::Manual::ResultClass> L<column definition
313 |DBIx::Class::ResultSource/add_columns>. Like L</set_column>, this
314 will not store the data in the database until L</insert> or L</update>
315 is called on the row.
323 =item Arguments: none
325 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
329 Inserts an object previously created by L</new> into the database if
330 it isn't already in there. Returns the object itself. To insert an
331 entirely new row into the database, use L<DBIx::Class::ResultSet/create>.
333 To fetch an uninserted result object, call
334 L<new_result|DBIx::Class::ResultSet/new_result> on a resultset.
336 This will also insert any uninserted, related objects held inside this
337 one, see L<DBIx::Class::ResultSet/create> for more details.
343 return $self if $self->in_storage;
344 my $rsrc = $self->result_source;
345 $self->throw_exception("No result_source set on this object; can't insert")
348 my $storage = $rsrc->schema->storage;
352 # Check if we stored uninserted relobjs here in new()
353 my %related_stuff = (%{$self->{_relationship_data} || {}},
354 %{$self->{_inflated_column} || {}});
356 # insert what needs to be inserted before us
358 for my $rel_name (keys %related_stuff) {
359 my $rel_obj = $related_stuff{$rel_name};
361 if (! $self->{_rel_in_storage}{$rel_name}) {
362 next unless (blessed $rel_obj && $rel_obj->isa(__PACKAGE__));
364 next unless $rsrc->_pk_depends_on(
365 $rel_name, { $rel_obj->get_columns }
368 # The guard will save us if we blow out of this scope via die
369 $rollback_guard ||= $storage->txn_scope_guard;
371 MULTICREATE_DEBUG and print STDERR "MC $self pre-reconstructing $rel_name $rel_obj\n";
373 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_columns };
376 # if there are no keys - nothing to search for
377 if (keys %$them and $existing = $rsrc->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->{$_})
423 defined $current_rowdata{$_}
425 # one of the few spots doing forced-stringification
426 # needed to work around objects with defined stringification
427 # but *without* overloaded comparison (ugh!)
428 "$current_rowdata{$_}" ne "$returned_cols->{$_}"
433 delete $self->{_column_data_in_storage};
434 $self->in_storage(1);
436 $self->{_dirty_columns} = {};
437 $self->{related_resultsets} = {};
439 foreach my $rel_name (keys %related_stuff) {
440 next unless $rsrc->has_relationship ($rel_name);
442 my @cands = ref $related_stuff{$rel_name} eq 'ARRAY'
443 ? @{$related_stuff{$rel_name}}
444 : $related_stuff{$rel_name}
447 if (@cands && blessed $cands[0] && $cands[0]->isa(__PACKAGE__)
449 my $reverse = $rsrc->reverse_relationship_info($rel_name);
450 foreach my $obj (@cands) {
451 $obj->set_from_related($_, $self) for keys %$reverse;
452 if ($self->__their_pk_needs_us($rel_name)) {
453 if (exists $self->{_ignore_at_insert}{$rel_name}) {
454 MULTICREATE_DEBUG and print STDERR "MC $self skipping post-insert on $rel_name\n";
457 MULTICREATE_DEBUG and print STDERR "MC $self inserting $rel_name $obj\n";
461 MULTICREATE_DEBUG and print STDERR "MC $self post-inserting $obj\n";
468 delete $self->{_ignore_at_insert};
470 $rollback_guard->commit if $rollback_guard;
477 $result->in_storage; # Get value
478 $result->in_storage(1); # Set value
482 =item Arguments: none or 1|0
484 =item Return Value: 1|0
488 Indicates whether the object exists as a row in the database or
489 not. This is set to true when L<DBIx::Class::ResultSet/find>,
490 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::Row/insert>
493 Creating a result object using L<DBIx::Class::ResultSet/new_result>, or
494 calling L</delete> on one, sets it to false.
499 $result->update(\%columns?)
503 =item Arguments: none or a hashref
505 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
509 Throws an exception if the result object is not yet in the database,
510 according to L</in_storage>. Returns the object itself.
512 This method issues an SQL UPDATE query to commit any changes to the
513 object to the database if required (see L</get_dirty_columns>).
514 It throws an exception if a proper WHERE clause uniquely identifying
515 the database row can not be constructed (see
516 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
519 Also takes an optional hashref of C<< column_name => value >> pairs
520 to update on the object first. Be aware that the hashref will be
521 passed to C<set_inflated_columns>, which might edit it in place, so
522 don't rely on it being the same after a call to C<update>. If you
523 need to preserve the hashref, it is sufficient to pass a shallow copy
524 to C<update>, e.g. ( { %{ $href } } )
526 If the values passed or any of the column values set on the object
527 contain scalar references, e.g.:
529 $result->last_modified(\'NOW()')->update();
531 $result->update({ last_modified => \'NOW()' });
533 The update will pass the values verbatim into SQL. (See
534 L<SQL::Abstract> docs). The values in your Result object will NOT change
535 as a result of the update call, if you want the object to be updated
536 with the actual values from the database, call L</discard_changes>
539 $result->update()->discard_changes();
541 To determine before calling this method, which column values have
542 changed and will be updated, call L</get_dirty_columns>.
544 To check if any columns will be updated, call L</is_changed>.
546 To force a column to be updated, call L</make_column_dirty> before
552 my ($self, $upd) = @_;
554 $self->set_inflated_columns($upd) if $upd;
556 my %to_update = $self->get_dirty_columns
559 $self->throw_exception( "Not in database" ) unless $self->in_storage;
561 my $rows = $self->result_source->schema->storage->update(
562 $self->result_source, \%to_update, $self->_storage_ident_condition
565 $self->throw_exception( "Can't update ${self}: row not found" );
566 } elsif ($rows > 1) {
567 $self->throw_exception("Can't update ${self}: updated more than one row");
569 $self->{_dirty_columns} = {};
570 $self->{related_resultsets} = {};
571 delete $self->{_column_data_in_storage};
581 =item Arguments: none
583 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
587 Throws an exception if the object is not in the database according to
588 L</in_storage>. Also throws an exception if a proper WHERE clause
589 uniquely identifying the database row can not be constructed (see
590 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
593 The object is still perfectly usable, but L</in_storage> will
594 now return 0 and the object must be reinserted using L</insert>
595 before it can be used to L</update> the row again.
597 If you delete an object in a class with a C<has_many> relationship, an
598 attempt is made to delete all the related objects as well. To turn
599 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
600 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
601 database-level cascade or restrict will take precedence over a
602 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
603 main row first> and only then attempts to delete any remaining related
606 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
607 and the transaction subsequently fails, the result object will remain marked as
608 not being in storage. If you know for a fact that the object is still in
609 storage (i.e. by inspecting the cause of the transaction's failure), you can
610 use C<< $obj->in_storage(1) >> to restore consistency between the object and
611 the database. This would allow a subsequent C<< $obj->delete >> to work
614 See also L<DBIx::Class::ResultSet/delete>.
621 $self->throw_exception( "Not in database" ) unless $self->in_storage;
623 $self->result_source->schema->storage->delete(
624 $self->result_source, $self->_storage_ident_condition
627 delete $self->{_column_data_in_storage};
628 $self->in_storage(0);
631 my $attrs = @_ > 1 && ref $_[-1] eq 'HASH' ? { %{pop(@_)} } : {};
632 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
633 $self->result_source->resultset->search_rs(@_)->delete;
640 my $val = $result->get_column($col);
644 =item Arguments: $columnname
646 =item Return Value: The value of the column
650 Throws an exception if the column name given doesn't exist according
651 to L<has_column|DBIx::Class::ResultSource/has_column>.
653 Returns a raw column value from the result object, if it has already
654 been fetched from the database or set by an accessor.
656 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
657 will be deflated and returned.
659 Note that if you used the C<columns> or the C<select/as>
660 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
661 which C<$result> was derived, and B<did not include> C<$columnname> in the list,
662 this method will return C<undef> even if the database contains some value.
664 To retrieve all loaded column values as a hash, use L</get_columns>.
669 my ($self, $column) = @_;
670 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
672 return $self->{_column_data}{$column}
673 if exists $self->{_column_data}{$column};
675 if (exists $self->{_inflated_column}{$column}) {
676 # deflate+return cycle
677 return $self->store_column($column, $self->_deflated_column(
678 $column, $self->{_inflated_column}{$column}
682 $self->throw_exception( "No such column '${column}' on " . ref $self )
683 unless $self->result_source->has_column($column);
688 =head2 has_column_loaded
690 if ( $result->has_column_loaded($col) ) {
691 print "$col has been loaded from db";
696 =item Arguments: $columnname
698 =item Return Value: 0|1
702 Returns a true value if the column value has been loaded from the
703 database (or set locally).
707 sub has_column_loaded {
708 my ($self, $column) = @_;
709 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
712 exists $self->{_inflated_column}{$column}
714 exists $self->{_column_data}{$column}
720 my %data = $result->get_columns;
724 =item Arguments: none
726 =item Return Value: A hash of columnname, value pairs.
730 Returns all loaded column data as a hash, containing raw values. To
731 get just one value for a particular column, use L</get_column>.
733 See L</get_inflated_columns> to get the inflated values.
739 if (exists $self->{_inflated_column}) {
740 # deflate cycle for each inflation, including filter rels
741 foreach my $col (keys %{$self->{_inflated_column}}) {
742 unless (exists $self->{_column_data}{$col}) {
744 # if cached related_resultset is present assume this was a prefetch
746 "Returning primary keys of prefetched 'filter' rels as part of get_columns() is deprecated and will "
747 . 'eventually be removed entirely (set DBIC_COLUMNS_INCLUDE_FILTER_RELS to disable this warning)'
749 ! $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS}
751 defined $self->{related_resultsets}{$col}
753 defined $self->{related_resultsets}{$col}->get_cache
756 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}));
760 return %{$self->{_column_data}};
763 =head2 get_dirty_columns
765 my %data = $result->get_dirty_columns;
769 =item Arguments: none
771 =item Return Value: A hash of column, value pairs
775 Only returns the column, value pairs for those columns that have been
776 changed on this object since the last L</update> or L</insert> call.
778 See L</get_columns> to fetch all column/value pairs.
782 sub get_dirty_columns {
784 return map { $_ => $self->{_column_data}{$_} }
785 keys %{$self->{_dirty_columns}};
788 =head2 make_column_dirty
790 $result->make_column_dirty($col)
794 =item Arguments: $columnname
796 =item Return Value: not defined
800 Throws an exception if the column does not exist.
802 Marks a column as having been changed regardless of whether it has
807 sub make_column_dirty {
808 my ($self, $column) = @_;
810 $self->throw_exception( "No such column '${column}' on " . ref $self )
811 unless exists $self->{_column_data}{$column} || $self->result_source->has_column($column);
813 # the entire clean/dirty code relies on exists, not on true/false
814 return 1 if exists $self->{_dirty_columns}{$column};
816 $self->{_dirty_columns}{$column} = 1;
818 # if we are just now making the column dirty, and if there is an inflated
819 # value, force it over the deflated one
820 if (exists $self->{_inflated_column}{$column}) {
821 $self->store_column($column,
822 $self->_deflated_column(
823 $column, $self->{_inflated_column}{$column}
829 =head2 get_inflated_columns
831 my %inflated_data = $obj->get_inflated_columns;
835 =item Arguments: none
837 =item Return Value: A hash of column, object|value pairs
841 Returns a hash of all column keys and associated values. Values for any
842 columns set to use inflation will be inflated and returns as objects.
844 See L</get_columns> to get the uninflated values.
846 See L<DBIx::Class::InflateColumn> for how to setup inflation.
850 sub get_inflated_columns {
853 my $loaded_colinfo = $self->result_source->columns_info;
854 $self->has_column_loaded($_) or delete $loaded_colinfo->{$_}
855 for keys %$loaded_colinfo;
857 my %cols_to_return = ( %{$self->{_column_data}}, %$loaded_colinfo );
859 unless ($ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS}) {
860 for (keys %$loaded_colinfo) {
861 # if cached related_resultset is present assume this was a prefetch
863 $loaded_colinfo->{$_}{_inflate_info}
865 defined $self->{related_resultsets}{$_}
867 defined $self->{related_resultsets}{$_}->get_cache
870 "Returning prefetched 'filter' rels as part of get_inflated_columns() is deprecated and will "
871 . 'eventually be removed entirely (set DBIC_COLUMNS_INCLUDE_FILTER_RELS to disable this warning)'
880 ! exists $loaded_colinfo->{$_}
883 exists $loaded_colinfo->{$_}{accessor}
885 ! defined $loaded_colinfo->{$_}{accessor}
887 ) ? $self->get_column($_)
889 defined $loaded_colinfo->{$_}{accessor}
890 ? $loaded_colinfo->{$_}{accessor}
893 )} keys %cols_to_return;
896 sub _is_column_numeric {
897 my ($self, $column) = @_;
902 unless ( $rsrc = $self->result_source )->has_column($column);
904 my $colinfo = $rsrc->columns_info->{$column};
906 # cache for speed (the object may *not* have a resultsource instance)
908 ! defined $colinfo->{is_numeric}
910 my $storage = dbic_internal_try { $rsrc->schema->storage }
912 $colinfo->{is_numeric} =
913 $storage->is_datatype_numeric ($colinfo->{data_type})
919 return $colinfo->{is_numeric};
924 $result->set_column($col => $val);
928 =item Arguments: $columnname, $value
930 =item Return Value: $value
934 Sets a raw column value. If the new value is different from the old one,
935 the column is marked as dirty for when you next call L</update>.
937 If passed an object or reference as a value, this method will happily
938 attempt to store it, and a later L</insert> or L</update> will try and
939 stringify/numify as appropriate. To set an object to be deflated
940 instead, see L</set_inflated_columns>, or better yet, use L</$column_accessor>.
945 my ($self, $column, $new_value) = @_;
947 my $had_value = $self->has_column_loaded($column);
948 my $old_value = $self->get_column($column);
950 $new_value = $self->store_column($column, $new_value);
953 $self->{_dirty_columns}{$column}
955 ( $self->in_storage # no point tracking dirtyness on uninserted data
956 ? ! $self->_eq_column_values ($column, $old_value, $new_value)
962 # FIXME sadly the update code just checks for keys, not for their value
963 $self->{_dirty_columns}{$column} = 1;
965 # Clear out the relation/inflation cache related to this column
967 # FIXME - this is a quick *largely incorrect* hack, pending a more
968 # serious rework during the merge of single and filter rels
969 my $rel_names = $self->result_source->{_relationships};
970 for my $rel_name (keys %$rel_names) {
972 my $acc = $rel_names->{$rel_name}{attrs}{accessor} || '';
974 if ( $acc eq 'single' and $rel_names->{$rel_name}{attrs}{fk_columns}{$column} ) {
975 delete $self->{related_resultsets}{$rel_name};
976 delete $self->{_relationship_data}{$rel_name};
977 #delete $self->{_inflated_column}{$rel_name};
979 elsif ( $acc eq 'filter' and $rel_name eq $column) {
980 delete $self->{related_resultsets}{$rel_name};
981 #delete $self->{_relationship_data}{$rel_name};
982 delete $self->{_inflated_column}{$rel_name};
987 # value change from something (even if NULL)
990 # no storage - no storage-value
993 # no value already stored (multiple changes before commit to storage)
994 ! exists $self->{_column_data_in_storage}{$column}
996 $self->_track_storage_value($column)
998 $self->{_column_data_in_storage}{$column} = $old_value;
1005 sub _eq_column_values {
1006 my ($self, $col, $old, $new) = @_;
1008 if (defined $old xor defined $new) {
1011 elsif (not defined $old) { # both undef
1015 is_literal_value $old
1017 is_literal_value $new
1021 elsif ($old eq $new) {
1024 elsif ($self->_is_column_numeric($col)) { # do a numeric comparison if datatype allows it
1025 return $old == $new;
1032 # returns a boolean indicating if the passed column should have its original
1033 # value tracked between column changes and commitment to storage
1034 sub _track_storage_value {
1035 my ($self, $col) = @_;
1038 $self->result_source->primary_columns
1044 $result->set_columns({ $col => $val, ... });
1048 =item Arguments: \%columndata
1050 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1054 Sets multiple column, raw value pairs at once.
1056 Works as L</set_column>.
1061 my ($self, $values) = @_;
1062 $self->set_column( $_, $values->{$_} ) for keys %$values;
1066 =head2 set_inflated_columns
1068 $result->set_inflated_columns({ $col => $val, $rel_name => $obj, ... });
1072 =item Arguments: \%columndata
1074 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1078 Sets more than one column value at once. Any inflated values are
1079 deflated and the raw values stored.
1081 Any related values passed as Result objects, using the relation name as a
1082 key, are reduced to the appropriate foreign key values and stored. If
1083 instead of related result objects, a hashref of column, value data is
1084 passed, will create the related object first then store.
1086 Will even accept arrayrefs of data as a value to a
1087 L<DBIx::Class::Relationship/has_many> key, and create the related
1088 objects if necessary.
1090 Be aware that the input hashref might be edited in place, so don't rely
1091 on it being the same after a call to C<set_inflated_columns>. If you
1092 need to preserve the hashref, it is sufficient to pass a shallow copy
1093 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
1095 See also L<DBIx::Class::Relationship::Base/set_from_related>.
1099 sub set_inflated_columns {
1100 my ( $self, $upd ) = @_;
1102 my ($rsrc, $colinfos);
1104 foreach my $key (keys %$upd) {
1105 if (ref $upd->{$key}) {
1106 $rsrc ||= $self->result_source;
1107 my $info = $rsrc->relationship_info($key);
1108 my $acc_type = $info->{attrs}{accessor} || '';
1110 if ($acc_type eq 'single') {
1111 my $rel_obj = delete $upd->{$key};
1112 $self->set_from_related($key => $rel_obj);
1113 $self->{_relationship_data}{$key} = $rel_obj;
1115 elsif ($acc_type eq 'multi') {
1116 $self->throw_exception(
1117 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
1122 ( $colinfos ||= $rsrc->columns_info )->{$key}
1125 )->{_inflate_info} )
1127 $self->set_inflated_column($key, delete $upd->{$key});
1131 $self->set_columns($upd);
1136 my $copy = $orig->copy({ change => $to, ... });
1140 =item Arguments: \%replacementdata
1142 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> copy
1146 Inserts a new row into the database, as a copy of the original
1147 object. If a hashref of replacement data is supplied, these will take
1148 precedence over data in the original. Also any columns which have
1149 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
1150 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
1151 so that the database can insert its own autoincremented values into
1154 Relationships will be followed by the copy procedure B<only> if the
1155 relationship specifies a true value for its
1156 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1157 is set by default on C<has_many> relationships and unset on all others.
1162 my ($self, $changes) = @_;
1164 my $col_data = { $self->get_columns };
1166 my $rsrc = $self->result_source;
1168 my $colinfo = $rsrc->columns_info;
1169 foreach my $col (keys %$col_data) {
1170 delete $col_data->{$col}
1171 if ( ! $colinfo->{$col} or $colinfo->{$col}{is_auto_increment} );
1174 my $new = { _column_data => $col_data };
1175 bless $new, ref $self;
1177 $new->result_source_instance($rsrc);
1178 $new->set_inflated_columns($changes);
1181 # Its possible we'll have 2 relations to the same Source. We need to make
1182 # sure we don't try to insert the same row twice else we'll violate unique
1184 my $rel_names_copied = {};
1186 foreach my $rel_name ($rsrc->relationships) {
1187 my $rel_info = $rsrc->relationship_info($rel_name);
1189 next unless $rel_info->{attrs}{cascade_copy};
1192 my $copied = $rel_names_copied->{ $rel_info->{source} } ||= {};
1194 $copied->{$_->ID}++ or $_->copy(
1196 $foreign_vals ||= $rsrc->_resolve_relationship_condition(
1197 require_join_free_values => 1,
1198 rel_name => $rel_name,
1199 self_result_object => $new,
1201 # an API where these are optional would be too cumbersome,
1202 # instead always pass in some dummy values
1204 )->{join_free_values}
1206 ) for $self->related_resultset($rel_name)->all;
1213 $result->store_column($col => $val);
1217 =item Arguments: $columnname, $value
1219 =item Return Value: The value sent to storage
1223 Set a raw value for a column without marking it as changed. This
1224 method is used internally by L</set_column> which you should probably
1227 This is the lowest level at which data is set on a result object,
1228 extend this method to catch all data setting methods.
1233 my ($self, $column, $value) = @_;
1234 $self->throw_exception( "No such column '${column}' on " . ref $self )
1235 unless exists $self->{_column_data}{$column} || $self->result_source->has_column($column);
1236 $self->throw_exception( "set_column called for ${column} without value" )
1240 $self->{_column_data}{$column} = (
1241 # unpack potential { -value => "foo" }
1242 ( length ref $value and $vref = is_plain_value( $value ) )
1248 =head2 inflate_result
1250 Class->inflate_result($result_source, \%me, \%prefetch?)
1254 =item Arguments: L<$result_source|DBIx::Class::ResultSource>, \%columndata, \%prefetcheddata
1256 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1260 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1261 database and turn it into result objects call this method.
1263 Extend this method in your Result classes to hook into this process,
1264 for example to rebless the result into a different class.
1266 Reblessing can also be done more easily by setting C<result_class> in
1267 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1269 Different types of results can also be created from a particular
1270 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1274 sub inflate_result {
1275 my ($class, $rsrc, $me, $prefetch) = @_;
1278 { _column_data => $me, _result_source => $rsrc },
1279 ref $class || $class
1283 for my $rel_name ( keys %$prefetch ) {
1285 my $relinfo = $rsrc->relationship_info($rel_name) or do {
1287 "Inflation into non-existent relationship '%s' of '%s' requested",
1291 if (my ($colname) = sort { length($a) <=> length ($b) } keys %{$prefetch->{$rel_name}[0] || {}} ) {
1292 $err .= sprintf ", check the inflation specification (columns/as) ending in '...%s.%s'",
1297 $rsrc->throw_exception($err);
1300 $class->throw_exception("No accessor type declared for prefetched relationship '$rel_name'")
1301 unless $relinfo->{attrs}{accessor};
1303 my $rel_rs = $new->related_resultset($rel_name);
1307 @{ $prefetch->{$rel_name} || [] }
1309 ref($prefetch->{$rel_name}) ne $DBIx::Class::ResultSource::RowParser::Util::null_branch_class
1312 if (ref $prefetch->{$rel_name}[0] eq 'ARRAY') {
1313 my $rel_rsrc = $rel_rs->result_source;
1314 my $rel_class = $rel_rs->result_class;
1315 my $rel_inflator = $rel_class->can('inflate_result');
1317 { $rel_class->$rel_inflator ( $rel_rsrc, @$_ ) }
1318 @{$prefetch->{$rel_name}}
1322 @rel_objects = $rel_rs->result_class->inflate_result(
1323 $rel_rs->result_source, @{$prefetch->{$rel_name}}
1328 if ($relinfo->{attrs}{accessor} eq 'single') {
1329 $new->{_relationship_data}{$rel_name} = $rel_objects[0];
1331 elsif ($relinfo->{attrs}{accessor} eq 'filter') {
1332 $new->{_inflated_column}{$rel_name} = $rel_objects[0];
1335 $rel_rs->set_cache(\@rel_objects);
1339 $new->in_storage (1);
1343 =head2 update_or_insert
1345 $result->update_or_insert
1349 =item Arguments: none
1351 =item Return Value: Result of update or insert operation
1355 L</update>s the object if it's already in the database, according to
1356 L</in_storage>, else L</insert>s it.
1358 =head2 insert_or_update
1360 $obj->insert_or_update
1362 Alias for L</update_or_insert>
1366 sub insert_or_update :DBIC_method_is_indirect_sugar {
1367 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1368 shift->update_or_insert(@_);
1371 sub update_or_insert {
1373 return ($self->in_storage ? $self->update : $self->insert);
1378 my @changed_col_names = $result->is_changed();
1379 if ($result->is_changed()) { ... }
1383 =item Arguments: none
1385 =item Return Value: 0|1 or @columnnames
1389 In list context returns a list of columns with uncommited changes, or
1390 in scalar context returns a true value if there are uncommitted
1396 return keys %{shift->{_dirty_columns} || {}};
1399 =head2 is_column_changed
1401 if ($result->is_column_changed('col')) { ... }
1405 =item Arguments: $columname
1407 =item Return Value: 0|1
1411 Returns a true value if the column has uncommitted changes.
1415 sub is_column_changed {
1416 my( $self, $col ) = @_;
1417 return exists $self->{_dirty_columns}->{$col};
1420 =head2 result_source
1422 my $resultsource = $result->result_source;
1426 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1428 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1432 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1436 sub result_source :DBIC_method_is_indirect_sugar {
1437 # While getter calls are routed through here for sensible exception text
1438 # it makes no sense to have setters do the same thing
1439 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS
1443 fail_on_internal_call;
1445 # this is essentially a `shift->result_source_instance(@_)` with handholding
1447 $_[0]->can('result_source_instance')
1449 $_[0]->throw_exception(
1450 "No ResultSource instance registered for '@{[ $_[0] ]}', did you forget to call @{[ ref $_[0] || $_[0] ]}->table(...) ?"
1455 =head2 register_column
1457 $column_info = { .... };
1458 $class->register_column($column_name, $column_info);
1462 =item Arguments: $columnname, \%columninfo
1464 =item Return Value: not defined
1468 Registers a column on the class. If the column_info has an 'accessor'
1469 key, creates an accessor named after the value if defined; if there is
1470 no such key, creates an accessor with the same name as the column
1472 The column_info attributes are described in
1473 L<DBIx::Class::ResultSource/add_columns>
1477 sub register_column {
1478 my ($class, $col, $info) = @_;
1480 if (exists $info->{accessor}) {
1481 return unless defined $info->{accessor};
1482 $acc = [ $info->{accessor}, $col ];
1484 $class->mk_group_accessors('column' => $acc);
1487 =head2 get_from_storage
1489 my $copy = $result->get_from_storage($attrs)
1493 =item Arguments: \%attrs
1495 =item Return Value: A Result object
1499 Fetches a fresh copy of the Result object from the database and returns it.
1500 Throws an exception if a proper WHERE clause identifying the database row
1501 can not be constructed (i.e. if the original object does not contain its
1503 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1504 ). If passed the \%attrs argument, will first apply these attributes to
1505 the resultset used to find the row.
1507 This copy can then be used to compare to an existing result object, to
1508 determine if any changes have been made in the database since it was
1511 To just update your Result object with any latest changes from the
1512 database, use L</discard_changes> instead.
1514 The \%attrs argument should be compatible with
1515 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1519 sub get_from_storage {
1520 my $self = shift @_;
1521 my $attrs = shift @_;
1522 my $resultset = $self->result_source->resultset;
1524 if(defined $attrs) {
1525 $resultset = $resultset->search(undef, $attrs);
1528 return $resultset->find($self->_storage_ident_condition);
1531 =head2 discard_changes
1533 $result->discard_changes
1537 =item Arguments: none or $attrs
1539 =item Return Value: self (updates object in-place)
1543 Re-selects the row from the database, losing any changes that had
1544 been made. Throws an exception if a proper C<WHERE> clause identifying
1545 the database row can not be constructed (i.e. if the original object
1546 does not contain its entire
1547 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>).
1549 This method can also be used to refresh from storage, retrieving any
1550 changes made since the row was last read from storage.
1552 $attrs, if supplied, is expected to be a hashref of attributes suitable for passing as the
1553 second argument to C<< $resultset->search($cond, $attrs) >>;
1555 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1556 storage, a default of
1557 L<< C<< { force_pool => 'master' } >>
1558 |DBIx::Class::Storage::DBI::Replicated/SYNOPSIS >> is automatically set for
1559 you. Prior to C<< DBIx::Class 0.08109 >> (before 2010) one would have been
1560 required to explicitly wrap the entire operation in a transaction to guarantee
1561 that up-to-date results are read from the master database.
1565 sub discard_changes {
1566 my ($self, $attrs) = @_;
1567 return unless $self->in_storage; # Don't reload if we aren't real!
1569 # add a replication default to read from the master only
1570 $attrs = { force_pool => 'master', %{$attrs||{}} };
1572 if( my $current_storage = $self->get_from_storage($attrs)) {
1574 # Set $self to the current.
1575 %$self = %$current_storage;
1577 # Avoid a possible infinite loop with
1578 # sub DESTROY { $_[0]->discard_changes }
1579 bless $current_storage, 'Do::Not::Exist';
1584 $self->in_storage(0);
1589 =head2 throw_exception
1591 See L<DBIx::Class::Schema/throw_exception>.
1595 sub throw_exception {
1599 ! DBIx::Class::_Util::in_internal_try
1601 # FIXME - the try is 99% superfluous, but just in case
1602 my $rsrc = dbic_internal_try { $self->result_source_instance }
1604 $rsrc->throw_exception(@_)
1607 DBIx::Class::Exception->throw(@_);
1613 my @pk = $result->id;
1617 =item Arguments: none
1619 =item Returns: A list of primary key values
1623 Returns the primary key(s) for a row. Can't be called as a class method.
1624 Actually implemented in L<DBIx::Class::PK>
1626 =head1 FURTHER QUESTIONS?
1628 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
1630 =head1 COPYRIGHT AND LICENSE
1632 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
1633 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
1634 redistribute it and/or modify it under the same terms as the
1635 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.