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;
19 $ENV{DBIC_MULTICREATE_DEBUG}
26 __PACKAGE__->mk_group_accessors ( simple => [ in_storage => '_in_storage' ] );
30 DBIx::Class::Row - Basic row methods
36 This class is responsible for defining and doing basic operations on rows
37 derived from L<DBIx::Class::ResultSource> objects.
39 Result objects are returned from L<DBIx::Class::ResultSet>s using the
40 L<create|DBIx::Class::ResultSet/create>, L<find|DBIx::Class::ResultSet/find>,
41 L<next|DBIx::Class::ResultSet/next> and L<all|DBIx::Class::ResultSet/all> methods,
42 as well as invocations of 'single' (
43 L<belongs_to|DBIx::Class::Relationship/belongs_to>,
44 L<has_one|DBIx::Class::Relationship/has_one> or
45 L<might_have|DBIx::Class::Relationship/might_have>)
46 relationship accessors of L<Result|DBIx::Class::Manual::ResultClass> objects.
50 All "Row objects" derived from a Schema-attached L<DBIx::Class::ResultSet>
51 object (such as a typical C<< L<search|DBIx::Class::ResultSet/search>->
52 L<next|DBIx::Class::ResultSet/next> >> call) are actually Result
53 instances, based on your application's
54 L<Result class|DBIx::Class::Manual::Glossary/Result_class>.
56 L<DBIx::Class::Row> implements most of the row-based communication with the
57 underlying storage, but a Result class B<should not inherit from it directly>.
58 Usually, Result classes inherit from L<DBIx::Class::Core>, which in turn
59 combines the methods from several classes, one of them being
60 L<DBIx::Class::Row>. Therefore, while many of the methods available to a
61 L<DBIx::Class::Core>-derived Result class are described in the following
62 documentation, it does not detail all of the methods available to Result
63 objects. Refer to L<DBIx::Class::Manual::ResultClass> for more info.
69 my $result = My::Class->new(\%attrs);
71 my $result = $schema->resultset('MySource')->new(\%colsandvalues);
75 =item Arguments: \%attrs or \%colsandvalues
77 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
81 While you can create a new result object by calling C<new> directly on
82 this class, you are better off calling it on a
83 L<DBIx::Class::ResultSet> object.
85 When calling it directly, you will not get a complete, usable row
86 object until you pass or set the C<result_source> attribute, to a
87 L<DBIx::Class::ResultSource> instance that is attached to a
88 L<DBIx::Class::Schema> with a valid connection.
90 C<$attrs> is a hashref of column name, value data. It can also contain
91 some other attributes such as the C<result_source>.
93 Passing an object, or an arrayref of objects as a value will call
94 L<DBIx::Class::Relationship::Base/set_from_related> for you. When
95 passed a hashref or an arrayref of hashrefs as the value, these will
96 be turned into objects via new_related, and treated as if you had
99 For a more involved explanation, see L<DBIx::Class::ResultSet/create>.
101 Please note that if a value is not passed to new, no value will be sent
102 in the SQL INSERT call, and the column will therefore assume whatever
103 default value was specified in your database. While DBIC will retrieve the
104 value of autoincrement columns, it will never make an explicit database
105 trip to retrieve default values assigned by the RDBMS. You can explicitly
106 request that all values be fetched back from the database by calling
107 L</discard_changes>, or you can supply an explicit C<undef> to columns
108 with NULL as the default, and save yourself a SELECT.
112 The behavior described above will backfire if you use a foreign key column
113 with a database-defined default. If you call the relationship accessor on
114 an object that doesn't have a set value for the FK column, DBIC will throw
115 an exception, as it has no way of knowing the PK of the related object (if
120 ## 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().
121 ## This only works because DBIC doesn't yet care to check whether the new_related objects have been passed all their mandatory columns
122 ## When doing the later insert, we need to make sure the PKs are set.
123 ## using _relationship_data in new and funky ways..
124 ## check Relationship::CascadeActions and Relationship::Accessor for compat
127 sub __new_related_find_or_new_helper {
128 my ($self, $relname, $values) = @_;
130 my $rsrc = $self->result_source;
132 # create a mock-object so all new/set_column component overrides will run:
133 my $rel_rs = $rsrc->related_source($relname)->resultset;
134 my $new_rel_obj = $rel_rs->new_result($values);
135 my $proc_data = { $new_rel_obj->get_columns };
137 if ($self->__their_pk_needs_us($relname)) {
138 MULTICREATE_DEBUG and print STDERR "MC $self constructing $relname via new_result\n";
141 elsif ($rsrc->_pk_depends_on($relname, $proc_data )) {
142 if (! keys %$proc_data) {
143 # there is nothing to search for - blind create
144 MULTICREATE_DEBUG and print STDERR "MC $self constructing default-insert $relname\n";
147 MULTICREATE_DEBUG and print STDERR "MC $self constructing $relname via find_or_new\n";
148 # this is not *really* find or new, as we don't want to double-new the
149 # data (thus potentially double encoding or whatever)
150 my $exists = $rel_rs->find ($proc_data);
151 return $exists if $exists;
156 my $us = $rsrc->source_name;
157 $self->throw_exception (
158 "Unable to determine relationship '$relname' direction from '$us', "
159 . "possibly due to a missing reverse-relationship on '$relname' to '$us'."
164 sub __their_pk_needs_us { # this should maybe be in resultsource.
165 my ($self, $relname) = @_;
166 my $rsrc = $self->result_source;
167 my $reverse = $rsrc->reverse_relationship_info($relname);
168 my $rel_source = $rsrc->related_source($relname);
169 my $us = { $self->get_columns };
170 foreach my $key (keys %$reverse) {
171 # if their primary key depends on us, then we have to
172 # just create a result and we'll fill it out afterwards
173 return 1 if $rel_source->_pk_depends_on($key, $us);
179 my ($class, $attrs) = @_;
180 $class = ref $class if ref $class;
182 my $new = bless { _column_data => {}, _in_storage => 0 }, $class;
185 $new->throw_exception("attrs must be a hashref")
186 unless ref($attrs) eq 'HASH';
188 my $rsrc = delete $attrs->{-result_source};
189 if ( my $h = delete $attrs->{-source_handle} ) {
190 $rsrc ||= $h->resolve;
193 $new->result_source($rsrc) if $rsrc;
195 if (my $col_from_rel = delete $attrs->{-cols_from_relations}) {
196 @{$new->{_ignore_at_insert}={}}{@$col_from_rel} = ();
199 my ($related,$inflated);
201 foreach my $key (keys %$attrs) {
202 if (ref $attrs->{$key}) {
203 ## Can we extract this lot to use with update(_or .. ) ?
204 $new->throw_exception("Can't do multi-create without result source")
206 my $info = $rsrc->relationship_info($key);
207 my $acc_type = $info->{attrs}{accessor} || '';
208 if ($acc_type eq 'single') {
209 my $rel_obj = delete $attrs->{$key};
210 if(!blessed $rel_obj) {
211 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
214 if ($rel_obj->in_storage) {
215 $new->{_rel_in_storage}{$key} = 1;
216 $new->set_from_related($key, $rel_obj);
218 MULTICREATE_DEBUG and print STDERR "MC $new uninserted $key $rel_obj\n";
221 $related->{$key} = $rel_obj;
224 elsif ($acc_type eq 'multi' && ref $attrs->{$key} eq 'ARRAY' ) {
225 my $others = delete $attrs->{$key};
226 my $total = @$others;
228 foreach my $idx (0 .. $#$others) {
229 my $rel_obj = $others->[$idx];
230 if(!blessed $rel_obj) {
231 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
234 if ($rel_obj->in_storage) {
235 $rel_obj->throw_exception ('A multi relationship can not be pre-existing when doing multicreate. Something went wrong');
237 MULTICREATE_DEBUG and
238 print STDERR "MC $new uninserted $key $rel_obj (${\($idx+1)} of $total)\n";
240 push(@objects, $rel_obj);
242 $related->{$key} = \@objects;
245 elsif ($acc_type eq 'filter') {
246 ## 'filter' should disappear and get merged in with 'single' above!
247 my $rel_obj = delete $attrs->{$key};
248 if(!blessed $rel_obj) {
249 $rel_obj = $new->__new_related_find_or_new_helper($key, $rel_obj);
251 if ($rel_obj->in_storage) {
252 $new->{_rel_in_storage}{$key} = 1;
255 MULTICREATE_DEBUG and print STDERR "MC $new uninserted $key $rel_obj\n";
257 $inflated->{$key} = $rel_obj;
259 } elsif ($class->has_column($key)
260 && $class->column_info($key)->{_inflate_info}) {
261 $inflated->{$key} = $attrs->{$key};
265 $new->throw_exception("No such column '$key' on $class")
266 unless $class->has_column($key);
267 $new->store_column($key => $attrs->{$key});
270 $new->{_relationship_data} = $related if $related;
271 $new->{_inflated_column} = $inflated if $inflated;
277 =head2 $column_accessor
279 # Each pair does the same thing
281 # (un-inflated, regular column)
282 my $val = $result->get_column('first_name');
283 my $val = $result->first_name;
285 $result->set_column('first_name' => $val);
286 $result->first_name($val);
288 # (inflated column via DBIx::Class::InflateColumn::DateTime)
289 my $val = $result->get_inflated_column('last_modified');
290 my $val = $result->last_modified;
292 $result->set_inflated_column('last_modified' => $val);
293 $result->last_modified($val);
297 =item Arguments: $value?
299 =item Return Value: $value
303 A column accessor method is created for each column, which is used for
304 getting/setting the value for that column.
306 The actual method name is based on the
307 L<accessor|DBIx::Class::ResultSource/accessor> name given during the
308 L<Result Class|DBIx::Class::Manual::ResultClass> L<column definition
309 |DBIx::Class::ResultSource/add_columns>. Like L</set_column>, this
310 will not store the data in the database until L</insert> or L</update>
311 is called on the row.
319 =item Arguments: none
321 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
325 Inserts an object previously created by L</new> into the database if
326 it isn't already in there. Returns the object itself. To insert an
327 entirely new row into the database, use L<DBIx::Class::ResultSet/create>.
329 To fetch an uninserted result object, call
330 L<new_result|DBIx::Class::ResultSet/new_result> on a resultset.
332 This will also insert any uninserted, related objects held inside this
333 one, see L<DBIx::Class::ResultSet/create> for more details.
339 return $self if $self->in_storage;
340 my $rsrc = $self->result_source;
341 $self->throw_exception("No result_source set on this object; can't insert")
344 my $storage = $rsrc->storage;
348 # Check if we stored uninserted relobjs here in new()
349 my %related_stuff = (%{$self->{_relationship_data} || {}},
350 %{$self->{_inflated_column} || {}});
352 # insert what needs to be inserted before us
354 for my $relname (keys %related_stuff) {
355 my $rel_obj = $related_stuff{$relname};
357 if (! $self->{_rel_in_storage}{$relname}) {
358 next unless (blessed $rel_obj && $rel_obj->isa('DBIx::Class::Row'));
360 next unless $rsrc->_pk_depends_on(
361 $relname, { $rel_obj->get_columns }
364 # The guard will save us if we blow out of this scope via die
365 $rollback_guard ||= $storage->txn_scope_guard;
367 MULTICREATE_DEBUG and print STDERR "MC $self pre-reconstructing $relname $rel_obj\n";
369 my $them = { %{$rel_obj->{_relationship_data} || {} }, $rel_obj->get_columns };
372 # if there are no keys - nothing to search for
373 if (keys %$them and $existing = $self->result_source
374 ->related_source($relname)
378 %{$rel_obj} = %{$existing};
384 $self->{_rel_in_storage}{$relname} = 1;
387 $self->set_from_related($relname, $rel_obj);
388 delete $related_stuff{$relname};
391 # start a transaction here if not started yet and there is more stuff
393 if (keys %related_stuff) {
394 $rollback_guard ||= $storage->txn_scope_guard
397 MULTICREATE_DEBUG and do {
398 no warnings 'uninitialized';
399 print STDERR "MC $self inserting (".join(', ', $self->get_columns).")\n";
402 # perform the insert - the storage will return everything it is asked to
403 # (autoinc primary columns and any retrieve_on_insert columns)
404 my %current_rowdata = $self->get_columns;
405 my $returned_cols = $storage->insert(
407 { %current_rowdata }, # what to insert, copy because the storage *will* change it
410 for (keys %$returned_cols) {
411 $self->store_column($_, $returned_cols->{$_})
412 # this ensures we fire store_column only once
413 # (some asshats like overriding it)
415 (!exists $current_rowdata{$_})
417 (defined $current_rowdata{$_} xor defined $returned_cols->{$_})
419 (defined $current_rowdata{$_} and $current_rowdata{$_} ne $returned_cols->{$_})
423 delete $self->{_column_data_in_storage};
424 $self->in_storage(1);
426 $self->{_dirty_columns} = {};
427 $self->{related_resultsets} = {};
429 foreach my $relname (keys %related_stuff) {
430 next unless $rsrc->has_relationship ($relname);
432 my @cands = ref $related_stuff{$relname} eq 'ARRAY'
433 ? @{$related_stuff{$relname}}
434 : $related_stuff{$relname}
437 if (@cands && blessed $cands[0] && $cands[0]->isa('DBIx::Class::Row')
439 my $reverse = $rsrc->reverse_relationship_info($relname);
440 foreach my $obj (@cands) {
441 $obj->set_from_related($_, $self) for keys %$reverse;
442 if ($self->__their_pk_needs_us($relname)) {
443 if (exists $self->{_ignore_at_insert}{$relname}) {
444 MULTICREATE_DEBUG and print STDERR "MC $self skipping post-insert on $relname\n";
447 MULTICREATE_DEBUG and print STDERR "MC $self inserting $relname $obj\n";
451 MULTICREATE_DEBUG and print STDERR "MC $self post-inserting $obj\n";
458 delete $self->{_ignore_at_insert};
460 $rollback_guard->commit if $rollback_guard;
467 $result->in_storage; # Get value
468 $result->in_storage(1); # Set value
472 =item Arguments: none or 1|0
474 =item Return Value: 1|0
478 Indicates whether the object exists as a row in the database or
479 not. This is set to true when L<DBIx::Class::ResultSet/find>,
480 L<DBIx::Class::ResultSet/create> or L<DBIx::Class::ResultSet/insert>
483 Creating a result object using L<DBIx::Class::ResultSet/new_result>, or
484 calling L</delete> on one, sets it to false.
489 $result->update(\%columns?)
493 =item Arguments: none or a hashref
495 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
499 Throws an exception if the result object is not yet in the database,
500 according to L</in_storage>. Returns the object itself.
502 This method issues an SQL UPDATE query to commit any changes to the
503 object to the database if required (see L</get_dirty_columns>).
504 It throws an exception if a proper WHERE clause uniquely identifying
505 the database row can not be constructed (see
506 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
509 Also takes an optional hashref of C<< column_name => value >> pairs
510 to update on the object first. Be aware that the hashref will be
511 passed to C<set_inflated_columns>, which might edit it in place, so
512 don't rely on it being the same after a call to C<update>. If you
513 need to preserve the hashref, it is sufficient to pass a shallow copy
514 to C<update>, e.g. ( { %{ $href } } )
516 If the values passed or any of the column values set on the object
517 contain scalar references, e.g.:
519 $result->last_modified(\'NOW()')->update();
521 $result->update({ last_modified => \'NOW()' });
523 The update will pass the values verbatim into SQL. (See
524 L<SQL::Abstract> docs). The values in your Result object will NOT change
525 as a result of the update call, if you want the object to be updated
526 with the actual values from the database, call L</discard_changes>
529 $result->update()->discard_changes();
531 To determine before calling this method, which column values have
532 changed and will be updated, call L</get_dirty_columns>.
534 To check if any columns will be updated, call L</is_changed>.
536 To force a column to be updated, call L</make_column_dirty> before
542 my ($self, $upd) = @_;
544 $self->set_inflated_columns($upd) if $upd;
546 my %to_update = $self->get_dirty_columns
549 $self->throw_exception( "Not in database" ) unless $self->in_storage;
551 my $rows = $self->result_source->storage->update(
552 $self->result_source, \%to_update, $self->_storage_ident_condition
555 $self->throw_exception( "Can't update ${self}: row not found" );
556 } elsif ($rows > 1) {
557 $self->throw_exception("Can't update ${self}: updated more than one row");
559 $self->{_dirty_columns} = {};
560 $self->{related_resultsets} = {};
561 delete $self->{_column_data_in_storage};
571 =item Arguments: none
573 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
577 Throws an exception if the object is not in the database according to
578 L</in_storage>. Also throws an exception if a proper WHERE clause
579 uniquely identifying the database row can not be constructed (see
580 L<significance of primary keys|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
583 The object is still perfectly usable, but L</in_storage> will
584 now return 0 and the object must be reinserted using L</insert>
585 before it can be used to L</update> the row again.
587 If you delete an object in a class with a C<has_many> relationship, an
588 attempt is made to delete all the related objects as well. To turn
589 this behaviour off, pass C<< cascade_delete => 0 >> in the C<$attr>
590 hashref of the relationship, see L<DBIx::Class::Relationship>. Any
591 database-level cascade or restrict will take precedence over a
592 DBIx-Class-based cascading delete, since DBIx-Class B<deletes the
593 main row first> and only then attempts to delete any remaining related
596 If you delete an object within a txn_do() (see L<DBIx::Class::Storage/txn_do>)
597 and the transaction subsequently fails, the result object will remain marked as
598 not being in storage. If you know for a fact that the object is still in
599 storage (i.e. by inspecting the cause of the transaction's failure), you can
600 use C<< $obj->in_storage(1) >> to restore consistency between the object and
601 the database. This would allow a subsequent C<< $obj->delete >> to work
604 See also L<DBIx::Class::ResultSet/delete>.
611 $self->throw_exception( "Not in database" ) unless $self->in_storage;
613 $self->result_source->storage->delete(
614 $self->result_source, $self->_storage_ident_condition
617 delete $self->{_column_data_in_storage};
618 $self->in_storage(0);
621 my $rsrc = try { $self->result_source_instance }
622 or $self->throw_exception("Can't do class delete without a ResultSource instance");
624 my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {};
625 my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_};
626 $rsrc->resultset->search(@_)->delete;
633 my $val = $result->get_column($col);
637 =item Arguments: $columnname
639 =item Return Value: The value of the column
643 Throws an exception if the column name given doesn't exist according
644 to L<has_column|DBIx::Class::ResultSource/has_column>.
646 Returns a raw column value from the result object, if it has already
647 been fetched from the database or set by an accessor.
649 If an L<inflated value|DBIx::Class::InflateColumn> has been set, it
650 will be deflated and returned.
652 Note that if you used the C<columns> or the C<select/as>
653 L<search attributes|DBIx::Class::ResultSet/ATTRIBUTES> on the resultset from
654 which C<$result> was derived, and B<did not include> C<$columnname> in the list,
655 this method will return C<undef> even if the database contains some value.
657 To retrieve all loaded column values as a hash, use L</get_columns>.
662 my ($self, $column) = @_;
663 $self->throw_exception( "Can't fetch data as class method" ) unless ref $self;
664 return $self->{_column_data}{$column} if exists $self->{_column_data}{$column};
665 if (exists $self->{_inflated_column}{$column}) {
666 return $self->store_column($column,
667 $self->_deflated_column($column, $self->{_inflated_column}{$column}));
669 $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column);
673 =head2 has_column_loaded
675 if ( $result->has_column_loaded($col) ) {
676 print "$col has been loaded from db";
681 =item Arguments: $columnname
683 =item Return Value: 0|1
687 Returns a true value if the column value has been loaded from the
688 database (or set locally).
692 sub has_column_loaded {
693 my ($self, $column) = @_;
694 $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self;
695 return 1 if exists $self->{_inflated_column}{$column};
696 return exists $self->{_column_data}{$column};
699 =head2 has_relationship_loaded
703 =item Arguments: $relationship_name
705 =item Return Value: true, if the relationship has been loaded.
711 sub has_relationship_loaded {
712 my ($self, $rel) = @_;
714 $self->throw_exception( "has_relationship_loaded needs a relationship name" )
717 # _relationship_data gets populated from related_resultsets when the rel
719 return exists $self->{_relationship_data}->{$rel}
720 || exists $self->{related_resultsets}->{$rel};
725 my %data = $result->get_columns;
729 =item Arguments: none
731 =item Return Value: A hash of columnname, value pairs.
735 Returns all loaded column data as a hash, containing raw values. To
736 get just one value for a particular column, use L</get_column>.
738 See L</get_inflated_columns> to get the inflated values.
744 if (exists $self->{_inflated_column}) {
745 foreach my $col (keys %{$self->{_inflated_column}}) {
746 unless (exists $self->{_column_data}{$col}) {
748 # if cached related_resultset is present assume this was a prefetch
750 "Returning primary keys of prefetched 'filter' rels as part of get_columns() is deprecated and will "
751 . 'eventually be removed entirely (set DBIC_COLUMNS_INCLUDE_FILTER_RELS to disable this warning)'
753 ! $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS}
755 defined $self->{related_resultsets}{$col}
757 defined $self->{related_resultsets}{$col}->get_cache
760 $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col}));
764 return %{$self->{_column_data}};
767 =head2 get_dirty_columns
769 my %data = $result->get_dirty_columns;
773 =item Arguments: none
775 =item Return Value: A hash of column, value pairs
779 Only returns the column, value pairs for those columns that have been
780 changed on this object since the last L</update> or L</insert> call.
782 See L</get_columns> to fetch all column/value pairs.
786 sub get_dirty_columns {
788 return map { $_ => $self->{_column_data}{$_} }
789 keys %{$self->{_dirty_columns}};
792 =head2 make_column_dirty
794 $result->make_column_dirty($col)
798 =item Arguments: $columnname
800 =item Return Value: not defined
804 Throws an exception if the column does not exist.
806 Marks a column as having been changed regardless of whether it has
811 sub make_column_dirty {
812 my ($self, $column) = @_;
814 $self->throw_exception( "No such column '${column}'" )
815 unless exists $self->{_column_data}{$column} || $self->has_column($column);
817 # the entire clean/dirty code relies on exists, not on true/false
818 return 1 if exists $self->{_dirty_columns}{$column};
820 $self->{_dirty_columns}{$column} = 1;
822 # if we are just now making the column dirty, and if there is an inflated
823 # value, force it over the deflated one
824 if (exists $self->{_inflated_column}{$column}) {
825 $self->store_column($column,
826 $self->_deflated_column(
827 $column, $self->{_inflated_column}{$column}
833 =head2 get_inflated_columns
835 my %inflated_data = $obj->get_inflated_columns;
839 =item Arguments: none
841 =item Return Value: A hash of column, object|value pairs
845 Returns a hash of all column keys and associated values. Values for any
846 columns set to use inflation will be inflated and returns as objects.
848 See L</get_columns> to get the uninflated values.
850 See L<DBIx::Class::InflateColumn> for how to setup inflation.
854 sub get_inflated_columns {
857 my $loaded_colinfo = $self->columns_info ([
858 grep { $self->has_column_loaded($_) } $self->columns
861 my %cols_to_return = ( %{$self->{_column_data}}, %$loaded_colinfo );
863 unless ($ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS}) {
864 for (keys %$loaded_colinfo) {
865 # if cached related_resultset is present assume this was a prefetch
867 $loaded_colinfo->{$_}{_inflate_info}
869 defined $self->{related_resultsets}{$_}
871 defined $self->{related_resultsets}{$_}->get_cache
874 "Returning prefetched 'filter' rels as part of get_inflated_columns() is deprecated and will "
875 . 'eventually be removed entirely (set DBIC_COLUMNS_INCLUDE_FILTER_RELS to disable this warning)'
884 ! exists $loaded_colinfo->{$_}
887 exists $loaded_colinfo->{$_}{accessor}
889 ! defined $loaded_colinfo->{$_}{accessor}
891 ) ? $self->get_column($_)
893 defined $loaded_colinfo->{$_}{accessor}
894 ? $loaded_colinfo->{$_}{accessor}
897 )} keys %cols_to_return;
900 sub _is_column_numeric {
901 my ($self, $column) = @_;
902 my $colinfo = $self->column_info ($column);
904 # cache for speed (the object may *not* have a resultsource instance)
906 ! defined $colinfo->{is_numeric}
908 my $storage = try { $self->result_source->schema->storage }
910 $colinfo->{is_numeric} =
911 $storage->is_datatype_numeric ($colinfo->{data_type})
917 return $colinfo->{is_numeric};
922 $result->set_column($col => $val);
926 =item Arguments: $columnname, $value
928 =item Return Value: $value
932 Sets a raw column value. If the new value is different from the old one,
933 the column is marked as dirty for when you next call L</update>.
935 If passed an object or reference as a value, this method will happily
936 attempt to store it, and a later L</insert> or L</update> will try and
937 stringify/numify as appropriate. To set an object to be deflated
938 instead, see L</set_inflated_columns>, or better yet, use L</$column_accessor>.
943 my ($self, $column, $new_value) = @_;
945 my $had_value = $self->has_column_loaded($column);
946 my ($old_value, $in_storage) = ($self->get_column($column), $self->in_storage)
949 $new_value = $self->store_column($column, $new_value);
952 $self->{_dirty_columns}{$column}
954 $in_storage # no point tracking dirtyness on uninserted data
955 ? ! $self->_eq_column_values ($column, $old_value, $new_value)
960 # FIXME sadly the update code just checks for keys, not for their value
961 $self->{_dirty_columns}{$column} = 1;
963 # Clear out the relation/inflation cache related to this column
965 # FIXME - this is a quick *largely incorrect* hack, pending a more
966 # serious rework during the merge of single and filter rels
967 my $relnames = $self->result_source->{_relationships};
968 for my $relname (keys %$relnames) {
970 my $acc = $relnames->{$relname}{attrs}{accessor} || '';
972 if ( $acc eq 'single' and $relnames->{$relname}{attrs}{fk_columns}{$column} ) {
973 delete $self->{related_resultsets}{$relname};
974 delete $self->{_relationship_data}{$relname};
975 #delete $self->{_inflated_column}{$relname};
977 elsif ( $acc eq 'filter' and $relname eq $column) {
978 delete $self->{related_resultsets}{$relname};
979 #delete $self->{_relationship_data}{$relname};
980 delete $self->{_inflated_column}{$relname};
985 # value change from something (even if NULL)
988 # no storage - no storage-value
991 # no value already stored (multiple changes before commit to storage)
992 ! exists $self->{_column_data_in_storage}{$column}
994 $self->_track_storage_value($column)
996 $self->{_column_data_in_storage}{$column} = $old_value;
1003 sub _eq_column_values {
1004 my ($self, $col, $old, $new) = @_;
1006 if (defined $old xor defined $new) {
1009 elsif (not defined $old) { # both undef
1012 elsif ($old eq $new) {
1015 elsif ($self->_is_column_numeric($col)) { # do a numeric comparison if datatype allows it
1016 return $old == $new;
1023 # returns a boolean indicating if the passed column should have its original
1024 # value tracked between column changes and commitment to storage
1025 sub _track_storage_value {
1026 my ($self, $col) = @_;
1027 return defined first { $col eq $_ } ($self->primary_columns);
1032 $result->set_columns({ $col => $val, ... });
1036 =item Arguments: \%columndata
1038 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1042 Sets multiple column, raw value pairs at once.
1044 Works as L</set_column>.
1049 my ($self, $values) = @_;
1050 $self->set_column( $_, $values->{$_} ) for keys %$values;
1054 =head2 set_inflated_columns
1056 $result->set_inflated_columns({ $col => $val, $relname => $obj, ... });
1060 =item Arguments: \%columndata
1062 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1066 Sets more than one column value at once. Any inflated values are
1067 deflated and the raw values stored.
1069 Any related values passed as Result objects, using the relation name as a
1070 key, are reduced to the appropriate foreign key values and stored. If
1071 instead of related result objects, a hashref of column, value data is
1072 passed, will create the related object first then store.
1074 Will even accept arrayrefs of data as a value to a
1075 L<DBIx::Class::Relationship/has_many> key, and create the related
1076 objects if necessary.
1078 Be aware that the input hashref might be edited in place, so don't rely
1079 on it being the same after a call to C<set_inflated_columns>. If you
1080 need to preserve the hashref, it is sufficient to pass a shallow copy
1081 to C<set_inflated_columns>, e.g. ( { %{ $href } } )
1083 See also L<DBIx::Class::Relationship::Base/set_from_related>.
1087 sub set_inflated_columns {
1088 my ( $self, $upd ) = @_;
1089 foreach my $key (keys %$upd) {
1090 if (ref $upd->{$key}) {
1091 my $info = $self->relationship_info($key);
1092 my $acc_type = $info->{attrs}{accessor} || '';
1093 if ($acc_type eq 'single') {
1094 my $rel_obj = delete $upd->{$key};
1095 $self->set_from_related($key => $rel_obj);
1096 $self->{_relationship_data}{$key} = $rel_obj;
1098 elsif ($acc_type eq 'multi') {
1099 $self->throw_exception(
1100 "Recursive update is not supported over relationships of type '$acc_type' ($key)"
1103 elsif ($self->has_column($key) && exists $self->column_info($key)->{_inflate_info}) {
1104 $self->set_inflated_column($key, delete $upd->{$key});
1108 $self->set_columns($upd);
1113 my $copy = $orig->copy({ change => $to, ... });
1117 =item Arguments: \%replacementdata
1119 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> copy
1123 Inserts a new row into the database, as a copy of the original
1124 object. If a hashref of replacement data is supplied, these will take
1125 precedence over data in the original. Also any columns which have
1126 the L<column info attribute|DBIx::Class::ResultSource/add_columns>
1127 C<< is_auto_increment => 1 >> are explicitly removed before the copy,
1128 so that the database can insert its own autoincremented values into
1131 Relationships will be followed by the copy procedure B<only> if the
1132 relationship specifies a true value for its
1133 L<cascade_copy|DBIx::Class::Relationship::Base> attribute. C<cascade_copy>
1134 is set by default on C<has_many> relationships and unset on all others.
1139 my ($self, $changes) = @_;
1141 my $col_data = { %{$self->{_column_data}} };
1143 my $colinfo = $self->columns_info([ keys %$col_data ]);
1144 foreach my $col (keys %$col_data) {
1145 delete $col_data->{$col}
1146 if $colinfo->{$col}{is_auto_increment};
1149 my $new = { _column_data => $col_data };
1150 bless $new, ref $self;
1152 $new->result_source($self->result_source);
1153 $new->set_inflated_columns($changes);
1156 # Its possible we'll have 2 relations to the same Source. We need to make
1157 # sure we don't try to insert the same row twice else we'll violate unique
1159 my $relnames_copied = {};
1161 foreach my $relname ($self->result_source->relationships) {
1162 my $rel_info = $self->result_source->relationship_info($relname);
1164 next unless $rel_info->{attrs}{cascade_copy};
1166 my $resolved = $self->result_source->_resolve_condition(
1167 $rel_info->{cond}, $relname, $new, $relname
1170 my $copied = $relnames_copied->{ $rel_info->{source} } ||= {};
1171 foreach my $related ($self->search_related($relname)->all) {
1172 my $id_str = join("\0", $related->id);
1173 next if $copied->{$id_str};
1174 $copied->{$id_str} = 1;
1175 my $rel_copy = $related->copy($resolved);
1184 $result->store_column($col => $val);
1188 =item Arguments: $columnname, $value
1190 =item Return Value: The value sent to storage
1194 Set a raw value for a column without marking it as changed. This
1195 method is used internally by L</set_column> which you should probably
1198 This is the lowest level at which data is set on a result object,
1199 extend this method to catch all data setting methods.
1204 my ($self, $column, $value) = @_;
1205 $self->throw_exception( "No such column '${column}'" )
1206 unless exists $self->{_column_data}{$column} || $self->has_column($column);
1207 $self->throw_exception( "set_column called for ${column} without value" )
1209 return $self->{_column_data}{$column} = $value;
1212 =head2 inflate_result
1214 Class->inflate_result($result_source, \%me, \%prefetch?)
1218 =item Arguments: L<$result_source|DBIx::Class::ResultSource>, \%columndata, \%prefetcheddata
1220 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
1224 All L<DBIx::Class::ResultSet> methods that retrieve data from the
1225 database and turn it into result objects call this method.
1227 Extend this method in your Result classes to hook into this process,
1228 for example to rebless the result into a different class.
1230 Reblessing can also be done more easily by setting C<result_class> in
1231 your Result class. See L<DBIx::Class::ResultSource/result_class>.
1233 Different types of results can also be created from a particular
1234 L<DBIx::Class::ResultSet>, see L<DBIx::Class::ResultSet/result_class>.
1238 sub inflate_result {
1239 my ($class, $rsrc, $me, $prefetch) = @_;
1242 { _column_data => $me, _result_source => $rsrc },
1243 ref $class || $class
1247 for my $relname ( keys %$prefetch ) {
1249 my $relinfo = $rsrc->relationship_info($relname) or do {
1251 "Inflation into non-existent relationship '%s' of '%s' requested",
1255 if (my ($colname) = sort { length($a) <=> length ($b) } keys %{$prefetch->{$relname}[0] || {}} ) {
1256 $err .= sprintf ", check the inflation specification (columns/as) ending in '...%s.%s'",
1261 $rsrc->throw_exception($err);
1264 $class->throw_exception("No accessor type declared for prefetched relationship '$relname'")
1265 unless $relinfo->{attrs}{accessor};
1269 $prefetch->{$relname}
1271 @{$prefetch->{$relname}}
1273 ref($prefetch->{$relname}) ne $DBIx::Class::ResultSource::RowParser::Util::null_branch_class
1276 my $rel_rs = $new->related_resultset($relname);
1278 if (ref $prefetch->{$relname}[0] eq 'ARRAY') {
1279 my $rel_rsrc = $rel_rs->result_source;
1280 my $rel_class = $rel_rs->result_class;
1281 my $rel_inflator = $rel_class->can('inflate_result');
1283 { $rel_class->$rel_inflator ( $rel_rsrc, @$_ ) }
1284 @{$prefetch->{$relname}}
1288 @rel_objects = $rel_rs->result_class->inflate_result(
1289 $rel_rs->result_source, @{$prefetch->{$relname}}
1294 if ($relinfo->{attrs}{accessor} eq 'single') {
1295 $new->{_relationship_data}{$relname} = $rel_objects[0];
1297 elsif ($relinfo->{attrs}{accessor} eq 'filter') {
1298 $new->{_inflated_column}{$relname} = $rel_objects[0];
1301 $new->related_resultset($relname)->set_cache(\@rel_objects);
1305 $new->in_storage (1);
1309 =head2 update_or_insert
1311 $result->update_or_insert
1315 =item Arguments: none
1317 =item Return Value: Result of update or insert operation
1321 L</Update>s the object if it's already in the database, according to
1322 L</in_storage>, else L</insert>s it.
1324 =head2 insert_or_update
1326 $obj->insert_or_update
1328 Alias for L</update_or_insert>
1332 sub insert_or_update { shift->update_or_insert(@_) }
1334 sub update_or_insert {
1336 return ($self->in_storage ? $self->update : $self->insert);
1341 my @changed_col_names = $result->is_changed();
1342 if ($result->is_changed()) { ... }
1346 =item Arguments: none
1348 =item Return Value: 0|1 or @columnnames
1352 In list context returns a list of columns with uncommited changes, or
1353 in scalar context returns a true value if there are uncommitted
1359 return keys %{shift->{_dirty_columns} || {}};
1362 =head2 is_column_changed
1364 if ($result->is_column_changed('col')) { ... }
1368 =item Arguments: $columname
1370 =item Return Value: 0|1
1374 Returns a true value if the column has uncommitted changes.
1378 sub is_column_changed {
1379 my( $self, $col ) = @_;
1380 return exists $self->{_dirty_columns}->{$col};
1383 =head2 result_source
1385 my $resultsource = $result->result_source;
1389 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1391 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1395 Accessor to the L<DBIx::Class::ResultSource> this object was created from.
1400 $_[0]->throw_exception( 'result_source can be called on instances only' )
1404 ? $_[0]->{_result_source} = $_[1]
1406 # note this is a || not a ||=, the difference is important
1407 : $_[0]->{_result_source} || do {
1408 my $class = ref $_[0];
1409 $_[0]->can('result_source_instance')
1410 ? $_[0]->result_source_instance
1411 : $_[0]->throw_exception(
1412 "No result source instance registered for $class, did you forget to call $class->table(...) ?"
1418 =head2 register_column
1420 $column_info = { .... };
1421 $class->register_column($column_name, $column_info);
1425 =item Arguments: $columnname, \%columninfo
1427 =item Return Value: not defined
1431 Registers a column on the class. If the column_info has an 'accessor'
1432 key, creates an accessor named after the value if defined; if there is
1433 no such key, creates an accessor with the same name as the column
1435 The column_info attributes are described in
1436 L<DBIx::Class::ResultSource/add_columns>
1440 sub register_column {
1441 my ($class, $col, $info) = @_;
1443 if (exists $info->{accessor}) {
1444 return unless defined $info->{accessor};
1445 $acc = [ $info->{accessor}, $col ];
1447 $class->mk_group_accessors('column' => $acc);
1450 =head2 get_from_storage
1452 my $copy = $result->get_from_storage($attrs)
1456 =item Arguments: \%attrs
1458 =item Return Value: A Result object
1462 Fetches a fresh copy of the Result object from the database and returns it.
1463 Throws an exception if a proper WHERE clause identifying the database row
1464 can not be constructed (i.e. if the original object does not contain its
1466 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
1467 ). If passed the \%attrs argument, will first apply these attributes to
1468 the resultset used to find the row.
1470 This copy can then be used to compare to an existing result object, to
1471 determine if any changes have been made in the database since it was
1474 To just update your Result object with any latest changes from the
1475 database, use L</discard_changes> instead.
1477 The \%attrs argument should be compatible with
1478 L<DBIx::Class::ResultSet/ATTRIBUTES>.
1482 sub get_from_storage {
1483 my $self = shift @_;
1484 my $attrs = shift @_;
1485 my $resultset = $self->result_source->resultset;
1487 if(defined $attrs) {
1488 $resultset = $resultset->search(undef, $attrs);
1491 return $resultset->find($self->_storage_ident_condition);
1494 =head2 discard_changes
1496 $result->discard_changes
1500 =item Arguments: none or $attrs
1502 =item Return Value: self (updates object in-place)
1506 Re-selects the row from the database, losing any changes that had
1507 been made. Throws an exception if a proper C<WHERE> clause identifying
1508 the database row can not be constructed (i.e. if the original object
1509 does not contain its entire
1510 L<primary key|DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>).
1512 This method can also be used to refresh from storage, retrieving any
1513 changes made since the row was last read from storage.
1515 $attrs, if supplied, is expected to be a hashref of attributes suitable for passing as the
1516 second argument to C<< $resultset->search($cond, $attrs) >>;
1518 Note: If you are using L<DBIx::Class::Storage::DBI::Replicated> as your
1519 storage, please kept in mind that if you L</discard_changes> on a row that you
1520 just updated or created, you should wrap the entire bit inside a transaction.
1521 Otherwise you run the risk that you insert or update to the master database
1522 but read from a replicant database that has not yet been updated from the
1523 master. This will result in unexpected results.
1527 sub discard_changes {
1528 my ($self, $attrs) = @_;
1529 return unless $self->in_storage; # Don't reload if we aren't real!
1531 # add a replication default to read from the master only
1532 $attrs = { force_pool => 'master', %{$attrs||{}} };
1534 if( my $current_storage = $self->get_from_storage($attrs)) {
1536 # Set $self to the current.
1537 %$self = %$current_storage;
1539 # Avoid a possible infinite loop with
1540 # sub DESTROY { $_[0]->discard_changes }
1541 bless $current_storage, 'Do::Not::Exist';
1546 $self->in_storage(0);
1551 =head2 throw_exception
1553 See L<DBIx::Class::Schema/throw_exception>.
1557 sub throw_exception {
1560 if (ref $self && ref $self->result_source ) {
1561 $self->result_source->throw_exception(@_)
1564 DBIx::Class::Exception->throw(@_);
1570 my @pk = $result->id;
1574 =item Arguments: none
1576 =item Returns: A list of primary key values
1580 Returns the primary key(s) for a row. Can't be called as a class method.
1581 Actually implemented in L<DBIx::Class::PK>
1583 =head1 AUTHOR AND CONTRIBUTORS
1585 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
1589 You may distribute this code under the same terms as Perl itself.