/usr/share/perl5/DBIx/Class/ResultSet/RecursiveUpdate.pm is in libdbix-class-resultset-recursiveupdate-perl 0.34-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 | use strict;
use warnings;
package DBIx::Class::ResultSet::RecursiveUpdate;
{
$DBIx::Class::ResultSet::RecursiveUpdate::VERSION = '0.34';
}
# ABSTRACT: like update_or_create - but recursive
use base qw(DBIx::Class::ResultSet);
sub recursive_update {
my ( $self, $updates, $attrs ) = @_;
my $fixed_fields;
my $unknown_params_ok;
my $m2m_force_set_rel;
# 0.21+ api
if ( defined $attrs && ref $attrs eq 'HASH' ) {
$fixed_fields = $attrs->{fixed_fields};
$unknown_params_ok = $attrs->{unknown_params_ok};
$m2m_force_set_rel = $attrs->{m2m_force_set_rel};
}
# pre 0.21 api
elsif ( defined $attrs && ref $attrs eq 'ARRAY' ) {
$fixed_fields = $attrs;
}
return DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update(
resultset => $self,
updates => $updates,
fixed_fields => $fixed_fields,
unknown_params_ok => $unknown_params_ok,
m2m_force_set_rel => $m2m_force_set_rel,
);
}
package DBIx::Class::ResultSet::RecursiveUpdate::Functions;
{
$DBIx::Class::ResultSet::RecursiveUpdate::Functions::VERSION = '0.34';
}
use Carp::Clan qw/^DBIx::Class|^HTML::FormHandler|^Try::Tiny/;
use Scalar::Util qw( blessed );
use List::MoreUtils qw/ any all/;
use Try::Tiny;
sub recursive_update {
my %params = @_;
my ( $self, $updates, $fixed_fields, $object, $resolved, $if_not_submitted,
$unknown_params_ok, $m2m_force_set_rel )
= @params{
qw/resultset updates fixed_fields object resolved if_not_submitted unknown_params_ok m2m_force_set_rel/
};
$resolved ||= {};
$ENV{DBIC_NULLABLE_KEY_NOWARN} = 1;
my $source = $self->result_source;
croak "first parameter needs to be defined"
unless defined $updates;
croak "first parameter needs to be a hashref"
unless ref($updates) eq 'HASH';
croak 'fixed fields needs to be an arrayref'
if defined $fixed_fields && ref $fixed_fields ne 'ARRAY';
# always warn about additional parameters if storage debugging is enabled
$unknown_params_ok = 0
if $source->storage->debug;
if ( blessed($updates) && $updates->isa('DBIx::Class::Row') ) {
return $updates;
}
my @pks = $source->primary_columns;
if ( !defined $object &&
all { exists $updates->{$_} } @pks ) {
my @pks = map { $updates->{$_} } @pks;
$object = $self->find( @pks, { key => 'primary' } );
}
my %fixed_fields = map { $_ => 1 } @$fixed_fields
if $fixed_fields;
# the updates hashref might contain the pk columns
# but with an undefined value
my @missing =
grep { !defined $updates->{$_} && !exists $fixed_fields{$_} } @pks;
if ( !defined $object && scalar @missing == 0 ) {
$object = $self->find( $updates, { key => 'primary' } );
}
# add the resolved columns to the updates hashref
$updates = { %$updates, %$resolved };
# the resolved hashref might contain the pk columns
# but with an undefined value
@missing = grep { !defined $resolved->{$_} } @missing;
if ( !defined $object && scalar @missing == 0 ) {
$object = $self->find( $updates, { key => 'primary' } );
}
# try to construct a new row object with all given update attributes
# and use it to find the row in the database
if ( !defined $object ) {
try {
$object = $self->new_result($updates)->get_from_storage;
};
}
$object = $self->new_result( {} )
unless defined $object;
# direct column accessors
my %columns;
# relations that that should be done before the row is inserted into the
# database like belongs_to
my %pre_updates;
# relations that that should be done after the row is inserted into the
# database like has_many, might_have and has_one
my %post_updates;
my %other_methods;
my %m2m_accessors;
my %columns_by_accessor = _get_columns_by_accessor($self);
for my $name ( keys %$updates ) {
# columns
if ( exists $columns_by_accessor{$name} &&
!( $source->has_relationship($name) && ref( $updates->{$name} ) ) ) {
$columns{$name} = $updates->{$name};
next;
}
# relationships
if ( $source->has_relationship($name) ) {
if ( _master_relation_cond( $self, $name ) ) {
$pre_updates{$name} = $updates->{$name};
next;
}
else {
$post_updates{$name} = $updates->{$name};
next;
}
}
# many-to-many helper accessors
if ( is_m2m( $self, $name ) ) {
# Transform m2m data into recursive has_many data
# if IntrospectableM2M is in use.
#
# This removes the overhead related to deleting and
# re-adding all relationships.
if ( !$m2m_force_set_rel && $source->result_class->can('_m2m_metadata') ) {
my $meta = $source->result_class->_m2m_metadata->{$name};
my $bridge_rel = $meta->{relation};
my $foreign_rel = $meta->{foreign_relation};
$post_updates{$bridge_rel} = [
map {
{ $foreign_rel => $_ }
} @{ $updates->{$name} }
];
}
# Fall back to set_$rel if IntrospectableM2M
# is not available. (removing and re-adding all relationships)
else {
$m2m_accessors{$name} = $updates->{$name};
}
next;
}
# accessors
if ( $object->can($name) && not $source->has_relationship($name) ) {
$other_methods{$name} = $updates->{$name};
next;
}
# unknown
# don't throw a warning instead of an exception to give users
# time to adapt to the new API
carp(
"No such column, relationship, many-to-many helper accessor or generic accessor '$name'"
) unless $unknown_params_ok;
}
# first update columns and other accessors
# so that later related records can be found
for my $name ( keys %columns ) {
$object->$name( $columns{$name} );
}
for my $name ( keys %other_methods ) {
$object->$name( $other_methods{$name} );
}
for my $name ( keys %pre_updates ) {
_update_relation( $self, $name, $pre_updates{$name}, $object, $if_not_submitted );
}
# $self->_delete_empty_auto_increment($object);
# don't allow insert to recurse to related objects
# do the recursion ourselves
# $object->{_rel_in_storage} = 1;
# Update if %other_methods because of possible custom update method
$object->update_or_insert if ( $object->is_changed || keys %other_methods );
$object->discard_changes;
# updating many_to_many
for my $name ( keys %m2m_accessors ) {
my $value = $m2m_accessors{$name};
# TODO: only first pk col is used
my ($pk) = _get_pk_for_related( $self, $name );
my @rows;
my $rel_source = $object->$name->result_source;
my @updates;
if ( defined $value && ref $value eq 'ARRAY' ) {
@updates = @{$value};
}
elsif ( defined $value && !ref $value ) {
@updates = ($value);
}
elsif ( defined $value ) {
carp "value of many-to-many rel '$name' must be an arrayref or scalar: $value";
}
for my $elem (@updates) {
if ( blessed($elem) && $elem->isa('DBIx::Class::Row') ) {
push @rows, $elem;
}
elsif ( ref $elem eq 'HASH' ) {
push @rows,
recursive_update(
resultset => $rel_source->resultset,
updates => $elem
);
}
else {
push @rows, $rel_source->resultset->find( { $pk => $elem } );
}
}
my $set_meth = 'set_' . $name;
$object->$set_meth( \@rows );
}
for my $name ( keys %post_updates ) {
# I'm not sure why the following is necessary, but sometimes we get here
# and the $object doesn't have a pk, and discard_changes must be executed
$object->discard_changes;
_update_relation( $self, $name, $post_updates{$name}, $object, $if_not_submitted );
}
delete $ENV{DBIC_NULLABLE_KEY_NOWARN};
return $object;
}
# returns DBIx::Class::ResultSource::column_info as a hash indexed by column accessor || name
sub _get_columns_by_accessor {
my $self = shift;
my $source = $self->result_source;
my %columns;
for my $name ( $source->columns ) {
my $info = $source->column_info($name);
$info->{name} = $name;
$columns{ $info->{accessor} || $name } = $info;
}
return %columns;
}
# Arguments: $rs, $name, $updates, $row, $if_not_submitted
sub _update_relation {
my ( $self, $name, $updates, $object, $if_not_submitted ) = @_;
# this should never happen because we're checking the paramters passed to
# recursive_update, but just to be sure...
$object->throw_exception("No such relationship '$name'")
unless $object->has_relationship($name);
my $info = $object->result_source->relationship_info($name);
my $attrs = $info->{attrs};
# get a related resultset without a condition
my $related_resultset = $self->related_resultset($name)->result_source->resultset;
my $resolved;
if ( $self->result_source->can('_resolve_condition') ) {
$resolved = $self->result_source->_resolve_condition( $info->{cond}, $name, $object, $name );
}
else {
$self->throw_exception("result_source must support _resolve_condition");
}
$resolved = {}
if defined $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION &&
$DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION == $resolved;
# This is a hack. I'm not sure that this will handle most
# custom code conditions yet. This needs tests.
my @rel_cols;
if ( ref $info->{cond} eq 'CODE' ) {
@rel_cols = keys %$resolved;
map { s/^me\.// } @rel_cols;
}
else {
@rel_cols = keys %{ $info->{cond} };
map { s/^foreign\.// } @rel_cols;
}
# find out if all related columns are nullable
my $all_fks_nullable = 1;
for my $rel_col (@rel_cols) {
$all_fks_nullable = 0
unless $related_resultset->result_source->column_info($rel_col)->{is_nullable};
}
$if_not_submitted = $all_fks_nullable ? 'set_to_null' : 'delete'
unless defined $if_not_submitted;
# the only valid datatype for a has_many rels is an arrayref
if ( $attrs->{accessor} eq 'multi' ) {
# handle undef like empty arrayref
$updates = []
unless defined $updates;
$self->throw_exception("data for has_many relationship '$name' must be an arrayref")
unless ref $updates eq 'ARRAY';
my @updated_objs;
for my $sub_updates ( @{$updates} ) {
my $sub_object = recursive_update(
resultset => $related_resultset,
updates => $sub_updates,
resolved => $resolved
);
push @updated_objs, $sub_object;
}
my @related_pks = $related_resultset->result_source->primary_columns;
my $rs_rel_delist = $object->$name;
# foreign table has a single pk column
if ( scalar @related_pks == 1 ) {
$rs_rel_delist = $rs_rel_delist->search_rs(
{
$self->current_source_alias . "." .
$related_pks[0] => { -not_in => [ map ( $_->id, @updated_objs ) ] }
}
);
}
# foreign table has multiple pk columns
else {
my @cond;
for my $obj (@updated_objs) {
my %cond_for_obj;
for my $col (@related_pks) {
$cond_for_obj{ $self->current_source_alias . ".$col" } =
$obj->get_column($col);
}
push @cond, \%cond_for_obj;
}
# only limit resultset if there are related rows left
if ( scalar @cond ) {
$rs_rel_delist = $rs_rel_delist->search_rs( { -not => [@cond] } );
}
}
if ( $if_not_submitted eq 'delete' ) {
$rs_rel_delist->delete;
}
elsif ( $if_not_submitted eq 'set_to_null' ) {
my %update = map { $_ => undef } @rel_cols;
$rs_rel_delist->update( \%update );
}
}
elsif ( $attrs->{accessor} eq 'single' ||
$attrs->{accessor} eq 'filter' ) {
my $sub_object;
if ( ref $updates ) {
my $no_new_object = 0;
my @pks = $related_resultset->result_source->primary_columns;
if ( all { exists $updates->{$_} } @pks ) {
$no_new_object = 1;
}
if ( blessed($updates) && $updates->isa('DBIx::Class::Row') ) {
$sub_object = $updates;
}
elsif ( $attrs->{accessor} eq 'single' &&
defined $object->$name )
{
$sub_object = recursive_update(
resultset => $related_resultset,
updates => $updates,
$no_new_object ? () : (object => $object->$name),
);
}
else {
$sub_object = recursive_update(
resultset => $related_resultset,
updates => $updates,
$no_new_object ? () : (resolved => $resolved),
);
}
}
else {
$sub_object = $related_resultset->find($updates)
unless (
!$updates &&
( exists $attrs->{join_type} &&
$attrs->{join_type} eq 'LEFT' )
);
}
my $join_type = $attrs->{join_type} || '';
# unmarked 'LEFT' join for belongs_to
my $might_belong_to =
( $attrs->{accessor} eq 'single' || $attrs->{accessor} eq 'filter' ) &&
$attrs->{is_foreign_key_constraint};
# adding check for custom condition that's a coderef
# this 'set_from_related' should probably not be called in lots of other
# situations too, but until that's worked out, kludge it
if ( ( $sub_object || $updates || $might_belong_to || $join_type eq 'LEFT' ) &&
ref $info->{cond} ne 'CODE' ) {
$object->set_from_related( $name, $sub_object );
}
}
else {
$self->throw_exception(
"recursive_update doesn't now how to handle relationship '$name' with accessor " .
$info->{attrs}{accessor} );
}
}
sub is_m2m {
my ( $self, $relation ) = @_;
my $rclass = $self->result_class;
# DBIx::Class::IntrospectableM2M
if ( $rclass->can('_m2m_metadata') ) {
return $rclass->_m2m_metadata->{$relation};
}
my $object = $self->new_result( {} );
if ( $object->can($relation) and
!$self->result_source->has_relationship($relation) and
$object->can( 'set_' . $relation ) ) {
return 1;
}
return;
}
sub get_m2m_source {
my ( $self, $relation ) = @_;
my $rclass = $self->result_class;
# DBIx::Class::IntrospectableM2M
if ( $rclass->can('_m2m_metadata') ) {
return $self->result_source->related_source(
$rclass->_m2m_metadata->{$relation}{relation} )
->related_source( $rclass->_m2m_metadata->{$relation}{foreign_relation} );
}
my $object = $self->new_result( {} );
my $r = $object->$relation;
return $r->result_source;
}
sub _delete_empty_auto_increment {
my ( $self, $object ) = @_;
for my $col ( keys %{ $object->{_column_data} } ) {
if (
$object->result_source->column_info($col)->{is_auto_increment} and
( !defined $object->{_column_data}{$col} or
$object->{_column_data}{$col} eq '' )
) {
delete $object->{_column_data}{$col};
}
}
}
sub _get_pk_for_related {
my ( $self, $relation ) = @_;
my $source;
if ( $self->result_source->has_relationship($relation) ) {
$source = $self->result_source->related_source($relation);
}
# many to many case
if ( is_m2m( $self, $relation ) ) {
$source = get_m2m_source( $self, $relation );
}
return $source->primary_columns;
}
# This function determines whether a relationship should be done before or
# after the row is inserted into the database
# relationships before: belongs_to
# relationships after: has_many, might_have and has_one
# true means before, false after
sub _master_relation_cond {
my ( $self, $name ) = @_;
my $source = $self->result_source;
my $info = $source->relationship_info($name);
# has_many rels are always after
return 0
if $info->{attrs}->{accessor} eq 'multi';
my @foreign_ids = _get_pk_for_related( $self, $name );
my $cond = $info->{cond};
sub _inner {
my ( $source, $cond, @foreign_ids ) = @_;
while ( my ( $f_key, $col ) = each %{$cond} ) {
# might_have is not master
$col =~ s/^self\.//;
$f_key =~ s/^foreign\.//;
if ( $source->column_info($col)->{is_auto_increment} ) {
return 0;
}
if ( any { $_ eq $f_key } @foreign_ids ) {
return 1;
}
}
return 0;
}
if ( ref $cond eq 'HASH' ) {
return _inner( $source, $cond, @foreign_ids );
}
# arrayref of hashrefs
elsif ( ref $cond eq 'ARRAY' ) {
for my $new_cond (@$cond) {
return _inner( $source, $new_cond, @foreign_ids );
}
}
# we have a custom join condition, so update afterward
elsif ( ref $cond eq 'CODE' ) {
return 0;
}
else {
$source->throw_exception( "unhandled relation condition " . ref($cond) );
}
return;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive
=head1 VERSION
version 0.34
=head1 SYNOPSIS
# The functional interface:
my $schema = MyDB::Schema->connect();
my $new_item = DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update(
resultset => $schema->resultset('User'),
updates => {
id => 1,
owned_dvds => [
{
title => "One Flew Over the Cuckoo's Nest"
}
]
},
unknown_params_ok => 1,
);
# As ResultSet subclass:
__PACKAGE__->load_namespaces( default_resultset_class => '+DBIx::Class::ResultSet::RecursiveUpdate' );
# in the Schema file (see t/lib/DBSchema.pm). Or appropriate 'use base' in the ResultSet classes.
my $user = $schema->resultset('User')->recursive_update({
id => 1,
owned_dvds => [
{
title => "One Flew Over the Cuckoo's Nest"
}
]
}, {
unknown_params_ok => 1,
});
# You'll get a warning if you pass non-result specific data to
# recursive_update. See L</"Additional data in the updates hashref">
# for more information how to prevent this.
=head1 DESCRIPTION
You can feed the ->create method of DBIx::Class with a recursive datastructure
and have the related records created. Unfortunately you cannot do a similar
thing with update_or_create. This module tries to fill that void until
L<DBIx::Class> has an api itself.
The functional interface can be used without modifications of the model,
for example by form processors like L<HTML::FormHandler::Model::DBIC>.
It is a base class for L<DBIx::Class::ResultSet>s providing the method
recursive_update which works just like update_or_create but can recursively
update or create result objects composed of multiple rows. All rows need to be
identified by primary keys so you need to provide them in the update structure
(unless they can be deduced from the parent row. For example a related row of
a belongs_to relationship). If any of the primary key columns are missing,
a new row will be created, with the expectation that the missing columns will
be filled by it (as in the case of auto_increment primary keys).
If the resultset itself stores an assignment for the primary key,
like in the case of:
my $restricted_rs = $user_rs->search( { id => 1 } );
you need to inform recursive_update about the additional predicate with the fixed_fields attribute:
my $user = $restricted_rs->recursive_update( {
owned_dvds => [
{
title => 'One Flew Over the Cuckoo's Nest'
}
]
},
{
fixed_fields => [ 'id' ],
}
);
For a many_to_many (pseudo) relation you can supply a list of primary keys
from the other table and it will link the record at hand to those and
only those records identified by them. This is convenient for handling web
forms with check boxes (or a select field with multiple choice) that lets you
update such (pseudo) relations.
For a description how to set up base classes for ResultSets see
L<DBIx::Class::Schema/load_namespaces>.
=head2 Additional data in the updates hashref
If you pass additional data to recursive_update which doesn't match a column
name, column accessor, relationship or many-to-many helper accessor, it will
throw a warning by default. To disable this behaviour you can set the
unknown_params_ok attribute to a true value.
The warning thrown is:
"No such column, relationship, many-to-many helper accessor or generic accessor '$key'"
When used by L<HTML::FormHandler::Model::DBIC> this can happen if you have
additional form fields that aren't relevant to the database but don't have the
noupdate attribute set to a true value.
NOTE: in a future version this behaviour will change and throw an exception
instead of a warning!
=head1 DESIGN CHOICES
Columns and relationships which are excluded from the updates hashref aren't
touched at all.
=head2 Treatment of belongs_to relations
In case the relationship is included but undefined in the updates hashref,
all columns forming the relationship will be set to null.
If not all of them are nullable, DBIx::Class will throw an error.
Updating the relationship:
my $dvd = $dvd_rs->recursive_update( {
id => 1,
owner => $user->id,
});
Clearing the relationship (only works if cols are nullable!):
my $dvd = $dvd_rs->recursive_update( {
id => 1,
owner => undef,
});
Updating a relationship including its (full) primary key:
my $dvd = $dvd_rs->recursive_update( {
id => 1,
owner => {
id => 2,
name => "George",
},
});
=head2 Treatment of might_have relationships
In case the relationship is included but undefined in the updates hashref,
all columns forming the relationship will be set to null.
Updating the relationship:
my $user = $user_rs->recursive_update( {
id => 1,
address => {
street => "101 Main Street",
city => "Podunk",
state => "New York",
}
});
Clearing the relationship:
my $user = $user_rs->recursive_update( {
id => 1,
address => undef,
});
=head2 Treatment of has_many relations
If a relationship key is included in the data structure with a value of undef
or an empty array, all existing related rows will be deleted, or their foreign
key columns will be set to null.
The exact behaviour depends on the nullability of the foreign key columns and
the value of the "if_not_submitted" parameter. The parameter defaults to
undefined which neither nullifies nor deletes.
When the array contains elements they are updated if they exist, created when
not and deleted if not included.
=head3 All foreign table columns are nullable
In this case recursive_update defaults to nullifying the foreign columns.
=head3 Not all foreign table columns are nullable
In this case recursive_update deletes the foreign rows.
Updating the relationship:
Passing ids:
my $user = $user_rs->recursive_update( {
id => 1,
owned_dvds => [1, 2],
});
Passing hashrefs:
my $user = $user_rs->recursive_update( {
id => 1,
owned_dvds => [
{
name => 'temp name 1',
},
{
name => 'temp name 2',
},
],
});
Passing objects:
my $user = $user_rs->recursive_update( {
id => 1,
owned_dvds => [ $dvd1, $dvd2 ],
});
You can even mix them:
my $user = $user_rs->recursive_update( {
id => 1,
owned_dvds => [ 1, { id => 2 } ],
});
Clearing the relationship:
my $user = $user_rs->recursive_update( {
id => 1,
owned_dvds => undef,
});
This is the same as passing an empty array:
my $user = $user_rs->recursive_update( {
id => 1,
owned_dvds => [],
});
=head2 Treatment of many-to-many pseudo relations
If a many-to-many accessor key is included in the data structure with a value
of undef or an empty array, all existing related rows are unlinked.
When the array contains elements they are updated if they exist, created when
not and deleted if not included.
RecursiveUpdate defaults to
calling 'set_$rel' to update many-to-many relationships.
See L<DBIx::Class::Relationship/many_to_many> for details.
set_$rel effectively removes and re-adds all relationship data,
even if the set of related items did not change at all.
If L<DBIx::Class::IntrospectableM2M> is in use, RecursiveUpdate will
look up the corresponding has_many relationship and use this to recursively
update the many-to-many relationship.
While both mechanisms have the same final result, deleting and re-adding
all relationship data can have unwanted consequences if triggers or
method modifiers are defined or logging modules like L<DBIx::Class::AuditLog>
are in use.
The traditional "set_$rel" behaviour can be forced by passing
"m2m_force_set_rel => 1" to recursive_update.
See L</is_m2m> for many-to-many pseudo relationship detection.
Updating the relationship:
Passing ids:
my $dvd = $dvd_rs->recursive_update( {
id => 1,
tags => [1, 2],
});
Passing hashrefs:
my $dvd = $dvd_rs->recursive_update( {
id => 1,
tags => [
{
id => 1,
file => 'file0'
},
{
id => 2,
file => 'file1',
},
],
});
Passing objects:
my $dvd = $dvd_rs->recursive_update( {
id => 1,
tags => [ $tag1, $tag2 ],
});
You can even mix them:
my $dvd = $dvd_rs->recursive_update( {
id => 1,
tags => [ 2, { id => 3 } ],
});
Clearing the relationship:
my $dvd = $dvd_rs->recursive_update( {
id => 1,
tags => undef,
});
This is the same as passing an empty array:
my $dvd = $dvd_rs->recursive_update( {
id => 1,
tags => [],
});
Make sure that set_$rel used to update many-to-many relationships
even if IntrospectableM2M is loaded:
my $dvd = $dvd_rs->recursive_update( {
id => 1,
tags => [1, 2],
},
{ m2m_force_set_rel => 1 },
);
=head1 INTERFACE
=head1 METHODS
=head2 recursive_update
The method that does the work here.
=head2 is_m2m
=over 4
=item Arguments: $name
=item Return Value: true, if $name is a many to many pseudo-relationship
=back
The function gets the information about m2m relations from
L<DBIx::Class::IntrospectableM2M>. If it isn't loaded in the ResultSource
class, the code relies on the fact:
if($object->can($name) and
!$object->result_source->has_relationship($name) and
$object->can( 'set_' . $name )
)
to identify a many to many pseudo relationship. In a similar ugly way the
ResultSource of that many to many pseudo relationship is detected.
So if you need many to many pseudo relationship support, it's strongly
recommended to load L<DBIx::Class::IntrospectableM2M> in your ResultSource
class!
=head2 get_m2m_source
=over 4
=item Arguments: $name
=item Return Value: $result_source
=back
=head1 CONFIGURATION AND ENVIRONMENT
DBIx::Class::RecursiveUpdate requires no configuration files or environment variables.
=head1 DEPENDENCIES
DBIx::Class
optional but recommended:
DBIx::Class::IntrospectableM2M
=head1 INCOMPATIBILITIES
None reported.
=head1 BUGS AND LIMITATIONS
The list of reported bugs can be viewed at L<http://rt.cpan.org/Public/Dist/Display.html?Name=DBIx-Class-ResultSet-RecursiveUpdate>.
Please report any bugs or feature requests to
C<bug-DBIx-Class-ResultSet-RecursiveUpdate@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.
=head1 AUTHORS
=over 4
=item *
Zbigniew Lukasiak <zby@cpan.org>
=item *
John Napiorkowski <jjnapiork@cpan.org>
=item *
Alexander Hartmaier <abraxxa@cpan.org>
=item *
Gerda Shank <gshank@cpan.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Zbigniew Lukasiak, John Napiorkowski, Alexander Hartmaier.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|