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;
260 } elsif ($class->has_column($key)
261 && $class->column_info($key)->{_inflate_info}) {
262 $inflated->{$key} = $attrs->{$key};
266 $new->store_column($key => $attrs->{$key});
269 $new->{_relationship_data} = $related if $related;
270 $new->{_inflated_column} = $inflated if $inflated;
276 =head2 $column_accessor
278 # Each pair does the same thing
280 # (un-inflated, regular column)
281 my $val = $result->get_column('first_name');
282 my $val = $result->first_name;
284 $result->set_column('first_name' => $val);
285 $result->first_name($val);
287 # (inflated column via DBIx::Class::InflateColumn::DateTime)
288 my $val = $result->get_inflated_column('last_modified');
289 my $val = $result->last_modified;
291 $result->set_inflated_column('last_modified' => $val);
292 $result->last_modified($val);
296 =item Arguments: $value?
298 =item Return Value: $value
302 A column accessor method is created for each column, which is used for
303 getting/setting the value for that column.
305 The actual method name is based on the
306 L<accessor|DBIx::Class::ResultSource/accessor> name given during the
307 L<Result Class|DBIx::Class::Manual::ResultClass> L<column definition
308 |DBIx::Class::ResultSource/add_columns>. Like L</set_column>, this
309 will not store the data in the database until L</insert> or L</update>
310 is called on the row.
318 =item Arguments: none
320 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
324 Inserts an object previously created by L</new> into the database if
325 it isn't already in there. Returns the object itself. To insert an
326 entirely new row into the database, use L<DBIx::Class::ResultSet/create>.
328 To fetch an uninserted result object, call
329 L<new_result|DBIx::Class::ResultSet/new_result> on a resultset.
331 This will also insert any uninserted, related objects held inside this
332 one, see L<DBIx::Class::ResultSet/create> for more details.
338 return $self if $self->in_storage;
339 my $rsrc = $self->result_source;
340 $self->throw_exception("No result_source set on this object; can't insert")
343 my $storage = $rsrc->storage;
347 # Check if we stored uninserted relobjs here in new()
348 my %related_stuff = (%{$self->{_relationship_data} || {}},
349 %{$self->{_inflated_column} || {}});
351 # insert what needs to be inserted before us
353 for my $rel_name (keys %related_stuff) {
354 my $rel_obj = $related_stuff{$rel_name};
356 if (! $self->{_rel_in_storage}{$rel_name}) {
357 next unless (blessed $rel_obj && $rel_obj->isa('DBIx::Class::Row'));
359 next unless $rsrc->_pk_depends_on(
360 $rel_name, { $rel_obj->get_columns }
363 # The guard will save us if we blow out of this scope via die
364 $rollback_guard ||= $storage->txn_scope_guard;
366 MULTICREATE_DEBUG and print STDERR "MC $self pre-reconstructing $rel_name $rel_obj\n";
368 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_columns };
371 # if there are no keys - nothing to search for
372 if (keys %$them and $existing = $self->result_source
373 ->related_source($rel_name)
377 %{$rel_obj} = %{$existing};
383 $self->{_rel_in_storage}{$rel_name} = 1;
386 $self->set_from_related($rel_name, $rel_obj);
387 delete $related_stuff{$rel_name};
390 # start a transaction here if not started yet and there is more stuff
392 if (keys %related_stuff) {
393 $rollback_guard ||= $storage->txn_scope_guard
396 MULTICREATE_DEBUG and do {
397 no warnings 'uninitialized';
398 print STDERR "MC $self inserting (".join(', ', $self->get_columns).")\n";
401 # perform the insert - the storage will return everything it is asked to
402 # (autoinc primary columns and any retrieve_on_insert columns)
403 my %current_rowdata = $self->get_columns;
404 my $returned_cols = $storage->insert(
406 { %current_rowdata }, # what to insert, copy because the storage *will* change it
409 for (keys %$returned_cols) {
410 $self->store_column($_, $returned_cols->{$_})
411 # this ensures we fire store_column only once
412 # (some asshats like overriding it)
414 (!exists $current_rowdata{$_})
416 (defined $current_rowdata{$_} xor defined $returned_cols->{$_})
418 (defined $current_rowdata{$_} and $current_rowdata{$_} ne $returned_cols->{$_})
422 delete $self->{_column_data_in_storage};
423 $self->in_storage(1);
425 $self->{_dirty_columns} = {};
426 $self->{related_resultsets} = {};
428 foreach my $rel_name (keys %related_stuff) {
429 next unless $rsrc->has_relationship ($rel_name);
431 my @cands = ref $related_stuff{$rel_name} eq 'ARRAY'
432 ? @{$related_stuff{$rel_name}}
433 : $related_stuff{$rel_name}
436 if (@cands && blessed $cands[0] && $cands[0]->isa('DBIx::Class::Row')
438 my $reverse = $rsrc->reverse_relationship_info($rel_name);
439 foreach my $obj (@cands) {
440 $obj->set_from_related($_, $self) for keys %$reverse;
441 if ($self->__their_pk_needs_us($rel_name)) {
442 if (exists $self->{_ignore_at_insert}{$rel_name}) {
443 MULTICREATE_DEBUG and print STDERR "MC $self skipping post-insert on $rel_name\n";
446 MULTICREATE_DEBUG and print STDERR "MC $self inserting $rel_name $obj\n";
450 MULTICREATE_DEBUG and print STDERR "MC $self post-inserting $obj\n";
457 delete $self->{_ignore_at_insert};
459 $rollback_guard->commit if $rollback_guard;
466 $result->in_storage; # Get value
467 $result->in_storage(1); # Set value
471 =item Arguments: none or 1|0
473 =item Return Value: 1|0
477 Indicates whether the object exists as a row in the database or
478 not. This is set to true when L<DBIx::Class::ResultSet/find>,
479 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
482 Creating a result object using L<DBIx::Class::ResultSet/new_result>, or
483 calling L</delete> on one, sets it to false.
488 $result->update(\%columns?)
492 =item Arguments: none or a hashref
494 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
498 Throws an exception if the result object is not yet in the database,
499 according to L</in_storage>. Returns the object itself.
501 This method issues an SQL UPDATE query to commit any changes to the
502 object to the database if required (see L</get_dirty_columns>).
503 It throws an exception if a proper WHERE clause uniquely identifying
504 the database row can not be constructed (see
505 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
508 Also takes an optional hashref of C<< column_name => value >> pairs
509 to update on the object first. Be aware that the hashref will be
510 passed to C<set_inflated_columns>, which might edit it in place, so
511 don't rely on it being the same after a call to C<update>. If you
512 need to preserve the hashref, it is sufficient to pass a shallow copy
513 to C<update>, e.g. ( { %{ $href } } )
515 If the values passed or any of the column values set on the object
516 contain scalar references, e.g.:
518 $result->last_modified(\'NOW()')->update();
520 $result->update({ last_modified => \'NOW()' });
522 The update will pass the values verbatim into SQL. (See
523 L<SQL::Abstract> docs). The values in your Result object will NOT change
524 as a result of the update call, if you want the object to be updated
525 with the actual values from the database, call L</discard_changes>
528 $result->update()->discard_changes();
530 To determine before calling this method, which column values have
531 changed and will be updated, call L</get_dirty_columns>.
533 To check if any columns will be updated, call L</is_changed>.
535 To force a column to be updated, call L</make_column_dirty> before
541 my ($self, $upd) = @_;
543 $self->set_inflated_columns($upd) if $upd;
545 my %to_update = $self->get_dirty_columns
548 $self->throw_exception( "Not in database" ) unless $self->in_storage;
550 my $rows = $self->result_source->storage->update(
551 $self->result_source, \%to_update, $self->_storage_ident_condition
554 $self->throw_exception( "Can't update ${self}: row not found" );
555 } elsif ($rows > 1) {
556 $self->throw_exception("Can't update ${self}: updated more than one row");
558 $self->{_dirty_columns} = {};
559 $self->{related_resultsets} = {};
560 delete $self->{_column_data_in_storage};
570 =item Arguments: none
572 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
576 Throws an exception if the object is not in the database according to
577 L</in_storage>. Also throws an exception if a proper WHERE clause
578 uniquely identifying the database row can not be constructed (see
579 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
582 The object is still perfectly usable, but L</in_storage> will
583 now return 0 and the object must be reinserted using L</insert>
584 before it can be used to L</update> the row again.
586 If you delete an object in a class with a C<has_many> relationship, an
587 attempt is made to delete all the related objects as well. To turn
588 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
589 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
590 database-level cascade or restrict will take precedence over a
591 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
592 main row first> and only then attempts to delete any remaining related
595 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
596 and the transaction subsequently fails, the result object will remain marked as
597 not being in storage. If you know for a fact that the object is still in
598 storage (i.e. by inspecting the cause of the transaction's failure), you can
599 use C<< $obj->in_storage(1) >> to restore consistency between the object and
600 the database. This would allow a subsequent C<< $obj->delete >> to work
603 See also L<DBIx::Class::ResultSet/delete>.
610 $self->throw_exception( "Not in database" ) unless $self->in_storage;
612 $self->result_source->storage->delete(
613 $self->result_source, $self->_storage_ident_condition
616 delete $self->{_column_data_in_storage};
617 $self->in_storage(0);
620 my $rsrc = try { $self->result_source_instance }
621 or $self->throw_exception("Can't do class delete without a ResultSource instance");
623 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
624 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
625 $rsrc->resultset->search(@_)->delete;
632 my $val = $result->get_column($col);
636 =item Arguments: $columnname
638 =item Return Value: The value of the column
642 Throws an exception if the column name given doesn't exist according
643 to L<has_column|DBIx::Class::ResultSource/has_column>.
645 Returns a raw column value from the result object, if it has already
646 been fetched from the database or set by an accessor.
648 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
649 will be deflated and returned.
651 Note that if you used the C<columns> or the C<select/as>
652 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
653 which C<$result> was derived, and B<did not include> C<$columnname> in the list,
654 this method will return C<undef> even if the database contains some value.
656 To retrieve all loaded column values as a hash, use L</get_columns>.
661 my ($self, $column) = @_;
662 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
664 return $self->{_column_data}{$column}
665 if exists $self->{_column_data}{$column};
667 if (exists $self->{_inflated_column}{$column}) {
668 # deflate+return cycle
669 return $self->store_column($column, $self->_deflated_column(
670 $column, $self->{_inflated_column}{$column}
674 $self->throw_exception( "No such column '${column}' on " . ref $self )
675 unless $self->has_column($column);
680 =head2 has_column_loaded
682 if ( $result->has_column_loaded($col) ) {
683 print "$col has been loaded from db";
688 =item Arguments: $columnname
690 =item Return Value: 0|1
694 Returns a true value if the column value has been loaded from the
695 database (or set locally).
699 sub has_column_loaded {
700 my ($self, $column) = @_;
701 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
704 exists $self->{_inflated_column}{$column}
706 exists $self->{_column_data}{$column}
712 my %data = $result->get_columns;
716 =item Arguments: none
718 =item Return Value: A hash of columnname, value pairs.
722 Returns all loaded column data as a hash, containing raw values. To
723 get just one value for a particular column, use L</get_column>.
725 See L</get_inflated_columns> to get the inflated values.
731 if (exists $self->{_inflated_column}) {
732 # deflate cycle for each inflation, including filter rels
733 foreach my $col (keys %{$self->{_inflated_column}}) {
734 unless (exists $self->{_column_data}{$col}) {
736 # if cached related_resultset is present assume this was a prefetch
738 "Returning primary keys of prefetched 'filter' rels as part of get_columns() is deprecated and will "
739 . 'eventually be removed entirely (set DBIC_COLUMNS_INCLUDE_FILTER_RELS to disable this warning)'
741 ! $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS}
743 defined $self->{related_resultsets}{$col}
745 defined $self->{related_resultsets}{$col}->get_cache
748 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}));
752 return %{$self->{_column_data}};
755 =head2 get_dirty_columns
757 my %data = $result->get_dirty_columns;
761 =item Arguments: none
763 =item Return Value: A hash of column, value pairs
767 Only returns the column, value pairs for those columns that have been
768 changed on this object since the last L</update> or L</insert> call.
770 See L</get_columns> to fetch all column/value pairs.
774 sub get_dirty_columns {
776 return map { $_ => $self->{_column_data}{$_} }
777 keys %{$self->{_dirty_columns}};
780 =head2 make_column_dirty
782 $result->make_column_dirty($col)
786 =item Arguments: $columnname
788 =item Return Value: not defined
792 Throws an exception if the column does not exist.
794 Marks a column as having been changed regardless of whether it has
799 sub make_column_dirty {
800 my ($self, $column) = @_;
802 $self->throw_exception( "No such column '${column}' on " . ref $self )
803 unless exists $self->{_column_data}{$column} || $self->has_column($column);
805 # the entire clean/dirty code relies on exists, not on true/false
806 return 1 if exists $self->{_dirty_columns}{$column};
808 $self->{_dirty_columns}{$column} = 1;
810 # if we are just now making the column dirty, and if there is an inflated
811 # value, force it over the deflated one
812 if (exists $self->{_inflated_column}{$column}) {
813 $self->store_column($column,
814 $self->_deflated_column(
815 $column, $self->{_inflated_column}{$column}
821 =head2 get_inflated_columns
823 my %inflated_data = $obj->get_inflated_columns;
827 =item Arguments: none
829 =item Return Value: A hash of column, object|value pairs
833 Returns a hash of all column keys and associated values. Values for any
834 columns set to use inflation will be inflated and returns as objects.
836 See L</get_columns> to get the uninflated values.
838 See L<DBIx::Class::InflateColumn> for how to setup inflation.
842 sub get_inflated_columns {
845 my $loaded_colinfo = $self->columns_info ([
846 grep { $self->has_column_loaded($_) } $self->columns
849 my %cols_to_return = ( %{$self->{_column_data}}, %$loaded_colinfo );
851 unless ($ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS}) {
852 for (keys %$loaded_colinfo) {
853 # if cached related_resultset is present assume this was a prefetch
855 $loaded_colinfo->{$_}{_inflate_info}
857 defined $self->{related_resultsets}{$_}
859 defined $self->{related_resultsets}{$_}->get_cache
862 "Returning prefetched 'filter' rels as part of get_inflated_columns() is deprecated and will "
863 . 'eventually be removed entirely (set DBIC_COLUMNS_INCLUDE_FILTER_RELS to disable this warning)'
872 ! exists $loaded_colinfo->{$_}
875 exists $loaded_colinfo->{$_}{accessor}
877 ! defined $loaded_colinfo->{$_}{accessor}
879 ) ? $self->get_column($_)
881 defined $loaded_colinfo->{$_}{accessor}
882 ? $loaded_colinfo->{$_}{accessor}
885 )} keys %cols_to_return;
888 sub _is_column_numeric {
889 my ($self, $column) = @_;
890 my $colinfo = $self->column_info ($column);
892 # cache for speed (the object may *not* have a resultsource instance)
894 ! defined $colinfo->{is_numeric}
896 my $storage = try { $self->result_source->schema->storage }
898 $colinfo->{is_numeric} =
899 $storage->is_datatype_numeric ($colinfo->{data_type})
905 return $colinfo->{is_numeric};
910 $result->set_column($col => $val);
914 =item Arguments: $columnname, $value
916 =item Return Value: $value
920 Sets a raw column value. If the new value is different from the old one,
921 the column is marked as dirty for when you next call L</update>.
923 If passed an object or reference as a value, this method will happily
924 attempt to store it, and a later L</insert> or L</update> will try and
925 stringify/numify as appropriate. To set an object to be deflated
926 instead, see L</set_inflated_columns>, or better yet, use L</$column_accessor>.
931 my ($self, $column, $new_value) = @_;
933 my $had_value = $self->has_column_loaded($column);
934 my $old_value = $self->get_column($column);
936 $new_value = $self->store_column($column, $new_value);
939 $self->{_dirty_columns}{$column}
941 $self->in_storage # no point tracking dirtyness on uninserted data
942 ? ! $self->_eq_column_values ($column, $old_value, $new_value)
947 # FIXME sadly the update code just checks for keys, not for their value
948 $self->{_dirty_columns}{$column} = 1;
950 # Clear out the relation/inflation cache related to this column
952 # FIXME - this is a quick *largely incorrect* hack, pending a more
953 # serious rework during the merge of single and filter rels
954 my $rel_names = $self->result_source->{_relationships};
955 for my $rel_name (keys %$rel_names) {
957 my $acc = $rel_names->{$rel_name}{attrs}{accessor} || '';
959 if ( $acc eq 'single' and $rel_names->{$rel_name}{attrs}{fk_columns}{$column} ) {
960 delete $self->{related_resultsets}{$rel_name};
961 delete $self->{_relationship_data}{$rel_name};
962 #delete $self->{_inflated_column}{$rel_name};
964 elsif ( $acc eq 'filter' and $rel_name eq $column) {
965 delete $self->{related_resultsets}{$rel_name};
966 #delete $self->{_relationship_data}{$rel_name};
967 delete $self->{_inflated_column}{$rel_name};
972 # value change from something (even if NULL)
975 # no storage - no storage-value
978 # no value already stored (multiple changes before commit to storage)
979 ! exists $self->{_column_data_in_storage}{$column}
981 $self->_track_storage_value($column)
983 $self->{_column_data_in_storage}{$column} = $old_value;
990 sub _eq_column_values {
991 my ($self, $col, $old, $new) = @_;
993 if (defined $old xor defined $new) {
996 elsif (not defined $old) { # both undef
1000 is_literal_value $old
1002 is_literal_value $new
1006 elsif ($old eq $new) {
1009 elsif ($self->_is_column_numeric($col)) { # do a numeric comparison if datatype allows it
1010 return $old == $new;
1017 # returns a boolean indicating if the passed column should have its original
1018 # value tracked between column changes and commitment to storage
1019 sub _track_storage_value {
1020 my ($self, $col) = @_;
1021 return defined first { $col eq $_ } ($self->primary_columns);
1026 $result->set_columns({ $col => $val, ... });
1030 =item Arguments: \%columndata
1032 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1036 Sets multiple column, raw value pairs at once.
1038 Works as L</set_column>.
1043 my ($self, $values) = @_;
1044 $self->set_column( $_, $values->{$_} ) for keys %$values;
1048 =head2 set_inflated_columns
1050 $result->set_inflated_columns({ $col => $val, $rel_name => $obj, ... });
1054 =item Arguments: \%columndata
1056 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1060 Sets more than one column value at once. Any inflated values are
1061 deflated and the raw values stored.
1063 Any related values passed as Result objects, using the relation name as a
1064 key, are reduced to the appropriate foreign key values and stored. If
1065 instead of related result objects, a hashref of column, value data is
1066 passed, will create the related object first then store.
1068 Will even accept arrayrefs of data as a value to a
1069 L<DBIx::Class::Relationship/has_many> key, and create the related
1070 objects if necessary.
1072 Be aware that the input hashref might be edited in place, so don't rely
1073 on it being the same after a call to C<set_inflated_columns>. If you
1074 need to preserve the hashref, it is sufficient to pass a shallow copy
1075 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
1077 See also L<DBIx::Class::Relationship::Base/set_from_related>.
1081 sub set_inflated_columns {
1082 my ( $self, $upd ) = @_;
1083 foreach my $key (keys %$upd) {
1084 if (ref $upd->{$key}) {
1085 my $info = $self->relationship_info($key);
1086 my $acc_type = $info->{attrs}{accessor} || '';
1088 if ($acc_type eq 'single') {
1089 my $rel_obj = delete $upd->{$key};
1090 $self->set_from_related($key => $rel_obj);
1091 $self->{_relationship_data}{$key} = $rel_obj;
1093 elsif ($acc_type eq 'multi') {
1094 $self->throw_exception(
1095 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
1098 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
1099 $self->set_inflated_column($key, delete $upd->{$key});
1103 $self->set_columns($upd);
1108 my $copy = $orig->copy({ change => $to, ... });
1112 =item Arguments: \%replacementdata
1114 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> copy
1118 Inserts a new row into the database, as a copy of the original
1119 object. If a hashref of replacement data is supplied, these will take
1120 precedence over data in the original. Also any columns which have
1121 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
1122 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
1123 so that the database can insert its own autoincremented values into
1126 Relationships will be followed by the copy procedure B<only> if the
1127 relationship specifies a true value for its
1128 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1129 is set by default on C<has_many> relationships and unset on all others.
1134 my ($self, $changes) = @_;
1136 my $col_data = { %{$self->{_column_data}} };
1138 my $colinfo = $self->columns_info([ keys %$col_data ]);
1139 foreach my $col (keys %$col_data) {
1140 delete $col_data->{$col}
1141 if $colinfo->{$col}{is_auto_increment};
1144 my $new = { _column_data => $col_data };
1145 bless $new, ref $self;
1147 $new->result_source($self->result_source);
1148 $new->set_inflated_columns($changes);
1151 # Its possible we'll have 2 relations to the same Source. We need to make
1152 # sure we don't try to insert the same row twice else we'll violate unique
1154 my $rel_names_copied = {};
1156 foreach my $rel_name ($self->result_source->relationships) {
1157 my $rel_info = $self->result_source->relationship_info($rel_name);
1159 next unless $rel_info->{attrs}{cascade_copy};
1161 my $resolved = $self->result_source->_resolve_condition(
1162 $rel_info->{cond}, $rel_name, $new, $rel_name
1165 my $copied = $rel_names_copied->{ $rel_info->{source} } ||= {};
1166 foreach my $related ($self->search_related($rel_name)->all) {
1167 my $id_str = join("\0", $related->id);
1168 next if $copied->{$id_str};
1169 $copied->{$id_str} = 1;
1170 my $rel_copy = $related->copy($resolved);
1179 $result->store_column($col => $val);
1183 =item Arguments: $columnname, $value
1185 =item Return Value: The value sent to storage
1189 Set a raw value for a column without marking it as changed. This
1190 method is used internally by L</set_column> which you should probably
1193 This is the lowest level at which data is set on a result object,
1194 extend this method to catch all data setting methods.
1199 my ($self, $column, $value) = @_;
1200 $self->throw_exception( "No such column '${column}' on " . ref $self )
1201 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1202 $self->throw_exception( "set_column called for ${column} without value" )
1204 return $self->{_column_data}{$column} = $value;
1207 =head2 inflate_result
1209 Class->inflate_result($result_source, \%me, \%prefetch?)
1213 =item Arguments: L<$result_source|DBIx::Class::ResultSource>, \%columndata, \%prefetcheddata
1215 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1219 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1220 database and turn it into result objects call this method.
1222 Extend this method in your Result classes to hook into this process,
1223 for example to rebless the result into a different class.
1225 Reblessing can also be done more easily by setting C<result_class> in
1226 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1228 Different types of results can also be created from a particular
1229 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1233 sub inflate_result {
1234 my ($class, $rsrc, $me, $prefetch) = @_;
1237 { _column_data => $me, _result_source => $rsrc },
1238 ref $class || $class
1242 for my $rel_name ( keys %$prefetch ) {
1244 my $relinfo = $rsrc->relationship_info($rel_name) or do {
1246 "Inflation into non-existent relationship '%s' of '%s' requested",
1250 if (my ($colname) = sort { length($a) <=> length ($b) } keys %{$prefetch->{$rel_name}[0] || {}} ) {
1251 $err .= sprintf ", check the inflation specification (columns/as) ending in '...%s.%s'",
1256 $rsrc->throw_exception($err);
1259 $class->throw_exception("No accessor type declared for prefetched relationship '$rel_name'")
1260 unless $relinfo->{attrs}{accessor};
1262 my $rel_rs = $new->related_resultset($rel_name);
1266 @{ $prefetch->{$rel_name} || [] }
1268 ref($prefetch->{$rel_name}) ne $DBIx::Class::ResultSource::RowParser::Util::null_branch_class
1271 if (ref $prefetch->{$rel_name}[0] eq 'ARRAY') {
1272 my $rel_rsrc = $rel_rs->result_source;
1273 my $rel_class = $rel_rs->result_class;
1274 my $rel_inflator = $rel_class->can('inflate_result');
1276 { $rel_class->$rel_inflator ( $rel_rsrc, @$_ ) }
1277 @{$prefetch->{$rel_name}}
1281 @rel_objects = $rel_rs->result_class->inflate_result(
1282 $rel_rs->result_source, @{$prefetch->{$rel_name}}
1287 if ($relinfo->{attrs}{accessor} eq 'single') {
1288 $new->{_relationship_data}{$rel_name} = $rel_objects[0];
1290 elsif ($relinfo->{attrs}{accessor} eq 'filter') {
1291 $new->{_inflated_column}{$rel_name} = $rel_objects[0];
1294 $rel_rs->set_cache(\@rel_objects);
1298 $new->in_storage (1);
1302 =head2 update_or_insert
1304 $result->update_or_insert
1308 =item Arguments: none
1310 =item Return Value: Result of update or insert operation
1314 L</Update>s the object if it's already in the database, according to
1315 L</in_storage>, else L</insert>s it.
1317 =head2 insert_or_update
1319 $obj->insert_or_update
1321 Alias for L</update_or_insert>
1325 sub insert_or_update { shift->update_or_insert(@_) }
1327 sub update_or_insert {
1329 return ($self->in_storage ? $self->update : $self->insert);
1334 my @changed_col_names = $result->is_changed();
1335 if ($result->is_changed()) { ... }
1339 =item Arguments: none
1341 =item Return Value: 0|1 or @columnnames
1345 In list context returns a list of columns with uncommited changes, or
1346 in scalar context returns a true value if there are uncommitted
1352 return keys %{shift->{_dirty_columns} || {}};
1355 =head2 is_column_changed
1357 if ($result->is_column_changed('col')) { ... }
1361 =item Arguments: $columname
1363 =item Return Value: 0|1
1367 Returns a true value if the column has uncommitted changes.
1371 sub is_column_changed {
1372 my( $self, $col ) = @_;
1373 return exists $self->{_dirty_columns}->{$col};
1376 =head2 result_source
1378 my $resultsource = $result->result_source;
1382 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1384 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1388 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1393 $_[0]->throw_exception( 'result_source can be called on instances only' )
1397 ? $_[0]->{_result_source} = $_[1]
1399 # note this is a || not a ||=, the difference is important
1400 : $_[0]->{_result_source} || do {
1401 my $class = ref $_[0];
1402 $_[0]->can('result_source_instance')
1403 ? $_[0]->result_source_instance
1404 : $_[0]->throw_exception(
1405 "No result source instance registered for $class, did you forget to call $class->table(...) ?"
1411 =head2 register_column
1413 $column_info = { .... };
1414 $class->register_column($column_name, $column_info);
1418 =item Arguments: $columnname, \%columninfo
1420 =item Return Value: not defined
1424 Registers a column on the class. If the column_info has an 'accessor'
1425 key, creates an accessor named after the value if defined; if there is
1426 no such key, creates an accessor with the same name as the column
1428 The column_info attributes are described in
1429 L<DBIx::Class::ResultSource/add_columns>
1433 sub register_column {
1434 my ($class, $col, $info) = @_;
1436 if (exists $info->{accessor}) {
1437 return unless defined $info->{accessor};
1438 $acc = [ $info->{accessor}, $col ];
1440 $class->mk_group_accessors('column' => $acc);
1443 =head2 get_from_storage
1445 my $copy = $result->get_from_storage($attrs)
1449 =item Arguments: \%attrs
1451 =item Return Value: A Result object
1455 Fetches a fresh copy of the Result object from the database and returns it.
1456 Throws an exception if a proper WHERE clause identifying the database row
1457 can not be constructed (i.e. if the original object does not contain its
1459 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1460 ). If passed the \%attrs argument, will first apply these attributes to
1461 the resultset used to find the row.
1463 This copy can then be used to compare to an existing result object, to
1464 determine if any changes have been made in the database since it was
1467 To just update your Result object with any latest changes from the
1468 database, use L</discard_changes> instead.
1470 The \%attrs argument should be compatible with
1471 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1475 sub get_from_storage {
1476 my $self = shift @_;
1477 my $attrs = shift @_;
1478 my $resultset = $self->result_source->resultset;
1480 if(defined $attrs) {
1481 $resultset = $resultset->search(undef, $attrs);
1484 return $resultset->find($self->_storage_ident_condition);
1487 =head2 discard_changes
1489 $result->discard_changes
1493 =item Arguments: none or $attrs
1495 =item Return Value: self (updates object in-place)
1499 Re-selects the row from the database, losing any changes that had
1500 been made. Throws an exception if a proper C<WHERE> clause identifying
1501 the database row can not be constructed (i.e. if the original object
1502 does not contain its entire
1503 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>).
1505 This method can also be used to refresh from storage, retrieving any
1506 changes made since the row was last read from storage.
1508 $attrs, if supplied, is expected to be a hashref of attributes suitable for passing as the
1509 second argument to C<< $resultset->search($cond, $attrs) >>;
1511 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1512 storage, a default of
1513 L<< C<< { force_pool => 'master' } >>
1514 |DBIx::Class::Storage::DBI::Replicated/SYNOPSIS >> is automatically set for
1515 you. Prior to C<< DBIx::Class 0.08109 >> (before 2010) one would have been
1516 required to explicitly wrap the entire operation in a transaction to guarantee
1517 that up-to-date results are read from the master database.
1521 sub discard_changes {
1522 my ($self, $attrs) = @_;
1523 return unless $self->in_storage; # Don't reload if we aren't real!
1525 # add a replication default to read from the master only
1526 $attrs = { force_pool => 'master', %{$attrs||{}} };
1528 if( my $current_storage = $self->get_from_storage($attrs)) {
1530 # Set $self to the current.
1531 %$self = %$current_storage;
1533 # Avoid a possible infinite loop with
1534 # sub DESTROY { $_[0]->discard_changes }
1535 bless $current_storage, 'Do::Not::Exist';
1540 $self->in_storage(0);
1545 =head2 throw_exception
1547 See L<DBIx::Class::Schema/throw_exception>.
1551 sub throw_exception {
1554 if (ref $self && ref $self->result_source ) {
1555 $self->result_source->throw_exception(@_)
1558 DBIx::Class::Exception->throw(@_);
1564 my @pk = $result->id;
1568 =item Arguments: none
1570 =item Returns: A list of primary key values
1574 Returns the primary key(s) for a row. Can't be called as a class method.
1575 Actually implemented in L<DBIx::Class::PK>
1577 =head1 AUTHOR AND CONTRIBUTORS
1579 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
1583 You may distribute this code under the same terms as Perl itself.