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 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
|
package DBIx::Class::ResultSource;
use strict;
use warnings;
use DBIx::Class::ResultSet;
use Carp::Clan qw/^DBIx::Class/;
use Storable;
use base qw/DBIx::Class/;
__PACKAGE__->load_components(qw/AccessorGroup/);
__PACKAGE__->mk_group_accessors('simple' => qw/_ordered_columns
_columns _primaries _unique_constraints name resultset_attributes
schema from _relationships column_info_from_storage source_name/);
__PACKAGE__->mk_group_accessors('component_class' => qw/resultset_class
result_class/);
=head1 NAME
DBIx::Class::ResultSource - Result source object
=head1 SYNOPSIS
=head1 DESCRIPTION
A ResultSource is a component of a schema from which results can be directly
retrieved, most usually a table (see L<DBIx::Class::ResultSource::Table>)
=head1 METHODS
=pod
=head2 new
$class->new();
$class->new({attribute_name => value});
Creates a new ResultSource object. Not normally called directly by end users.
=cut
sub new {
my ($class, $attrs) = @_;
$class = ref $class if ref $class;
my $new = { %{$attrs || {}}, _resultset => undef };
bless $new, $class;
$new->{resultset_class} ||= 'DBIx::Class::ResultSet';
$new->{resultset_attributes} = { %{$new->{resultset_attributes} || {}} };
$new->{_ordered_columns} = [ @{$new->{_ordered_columns}||[]}];
$new->{_columns} = { %{$new->{_columns}||{}} };
$new->{_relationships} = { %{$new->{_relationships}||{}} };
$new->{name} ||= "!!NAME NOT SET!!";
$new->{_columns_info_loaded} ||= 0;
if(!defined $new->column_info_from_storage) {
$new->{column_info_from_storage} = 1
}
return $new;
}
=pod
=head2 add_columns
$table->add_columns(qw/col1 col2 col3/);
$table->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...);
Adds columns to the result source. If supplied key => hashref pairs, uses
the hashref as the column_info for that column. Repeated calls of this
method will add more columns, not replace them.
The contents of the column_info are not set in stone. The following
keys are currently recognised/used by DBIx::Class:
=over 4
=item accessor
Use this to set the name of the accessor for this column. If unset,
the name of the column will be used.
=item data_type
This contains the column type. It is automatically filled by the
L<SQL::Translator::Producer::DBIx::Class::File> producer, and the
L<DBIx::Class::Schema::Loader> module. If you do not enter a
data_type, DBIx::Class will attempt to retrieve it from the
database for you, using L<DBI>'s column_info method. The values of this
key are typically upper-cased.
Currently there is no standard set of values for the data_type. Use
whatever your database supports.
=item size
The length of your column, if it is a column type that can have a size
restriction. This is currently only used by L<DBIx::Class::Schema/deploy>.
=item is_nullable
Set this to a true value for a columns that is allowed to contain
NULL values. This is currently only used by L<DBIx::Class::Schema/deploy>.
=item is_auto_increment
Set this to a true value for a column whose value is somehow
automatically set. This is used to determine which columns to empty
when cloning objects using C<copy>. It is also used by
L<DBIx::Class::Schema/deploy>.
=item is_foreign_key
Set this to a true value for a column that contains a key from a
foreign table. This is currently only used by
L<DBIx::Class::Schema/deploy>.
=item default_value
Set this to the default value which will be inserted into a column
by the database. Can contain either a value or a function. This is
currently only used by L<DBIx::Class::Schema/deploy>.
=item sequence
Set this on a primary key column to the name of the sequence used to
generate a new key value. If not specified, L<DBIx::Class::PK::Auto>
will attempt to retrieve the name of the sequence from the database
automatically.
=item extras
This is used by L<DBIx::Class::Schema/deploy> and L<SQL::Translator>
to add extra non-generic data to the column. For example: C<< extras
=> { unsigned => 1} >> is used by the MySQL producer to set an integer
column to unsigned. For more details, see
L<SQL::Translator::Producer::MySQL>.
=back
=head2 add_column
$table->add_column('col' => \%info?);
Convenience alias to add_columns.
=cut
sub add_columns {
my ($self, @cols) = @_;
$self->_ordered_columns(\@cols) unless $self->_ordered_columns;
my @added;
my $columns = $self->_columns;
while (my $col = shift @cols) {
# If next entry is { ... } use that for the column info, if not
# use an empty hashref
my $column_info = ref $cols[0] ? shift(@cols) : {};
push(@added, $col) unless exists $columns->{$col};
$columns->{$col} = $column_info;
}
push @{ $self->_ordered_columns }, @added;
return $self;
}
*add_column = \&add_columns;
=head2 has_column
if ($obj->has_column($col)) { ... }
Returns true if the source has a column of this name, false otherwise.
=cut
sub has_column {
my ($self, $column) = @_;
return exists $self->_columns->{$column};
}
=head2 column_info
my $info = $obj->column_info($col);
Returns the column metadata hashref for a column. See the description
of add_column for information on the contents of the hashref.
=cut
sub column_info {
my ($self, $column) = @_;
$self->throw_exception("No such column $column")
unless exists $self->_columns->{$column};
#warn $self->{_columns_info_loaded}, "\n";
if ( ! $self->_columns->{$column}{data_type}
and $self->column_info_from_storage
and ! $self->{_columns_info_loaded}
and $self->schema and $self->storage )
{
$self->{_columns_info_loaded}++;
my $info = {};
my $lc_info = {};
# eval for the case of storage without table
eval { $info = $self->storage->columns_info_for( $self->from ) };
unless ($@) {
for my $realcol ( keys %{$info} ) {
$lc_info->{lc $realcol} = $info->{$realcol};
}
foreach my $col ( keys %{$self->_columns} ) {
$self->_columns->{$col} = {
%{ $self->_columns->{$col} },
%{ $info->{$col} || $lc_info->{lc $col} || {} }
};
}
}
}
return $self->_columns->{$column};
}
=head2 column_info_from_storage
Enables or disables the on-demand automatic loading of the above
column metadata from storage as neccesary. Defaults to true in the
current release, but will default to false in future releases starting
with 0.08000. This is *deprecated*, and should not be used. It will
be removed before 1.0.
__PACKAGE__->column_info_from_storage(0);
__PACKAGE__->column_info_from_storage(1);
=head2 columns
my @column_names = $obj->columns;
Returns all column names in the order they were declared to add_columns.
=cut
sub columns {
my $self = shift;
$self->throw_exception(
"columns() is a read-only accessor, did you mean add_columns()?"
) if (@_ > 1);
return @{$self->{_ordered_columns}||[]};
}
=head2 remove_columns
$table->remove_columns(qw/col1 col2 col3/);
Removes columns from the result source.
=head2 remove_column
$table->remove_column('col');
Convenience alias to remove_columns.
=cut
sub remove_columns {
my ($self, @cols) = @_;
return unless $self->_ordered_columns;
my $columns = $self->_columns;
my @remaining;
foreach my $col (@{$self->_ordered_columns}) {
push @remaining, $col unless grep(/$col/, @cols);
}
foreach (@cols) {
delete $columns->{$_};
};
$self->_ordered_columns(\@remaining);
}
*remove_column = \&remove_columns;
=head2 set_primary_key
=over 4
=item Arguments: @cols
=back
Defines one or more columns as primary key for this source. Should be
called after C<add_columns>.
Additionally, defines a unique constraint named C<primary>.
The primary key columns are used by L<DBIx::Class::PK::Auto> to
retrieve automatically created values from the database.
=cut
sub set_primary_key {
my ($self, @cols) = @_;
# check if primary key columns are valid columns
foreach my $col (@cols) {
$self->throw_exception("No such column $col on table " . $self->name)
unless $self->has_column($col);
}
$self->_primaries(\@cols);
$self->add_unique_constraint(primary => \@cols);
}
=head2 primary_columns
Read-only accessor which returns the list of primary keys.
=cut
sub primary_columns {
return @{shift->_primaries||[]};
}
=head2 add_unique_constraint
Declare a unique constraint on this source. Call once for each unique
constraint.
# For UNIQUE (column1, column2)
__PACKAGE__->add_unique_constraint(
constraint_name => [ qw/column1 column2/ ],
);
Alternatively, you can specify only the columns:
__PACKAGE__->add_unique_constraint([ qw/column1 column2/ ]);
This will result in a unique constraint named C<table_column1_column2>, where
C<table> is replaced with the table name.
Unique constraints are used, for example, when you call
L<DBIx::Class::ResultSet/find>. Only columns in the constraint are searched.
=cut
sub add_unique_constraint {
my $self = shift;
my $cols = pop @_;
my $name = shift;
$name ||= $self->name_unique_constraint($cols);
foreach my $col (@$cols) {
$self->throw_exception("No such column $col on table " . $self->name)
unless $self->has_column($col);
}
my %unique_constraints = $self->unique_constraints;
$unique_constraints{$name} = $cols;
$self->_unique_constraints(\%unique_constraints);
}
=head2 name_unique_constraint
Return a name for a unique constraint containing the specified columns. These
names consist of the table name and each column name, separated by underscores.
For example, a constraint on a table named C<cd> containing the columns
C<artist> and C<title> would result in a constraint name of C<cd_artist_title>.
=cut
sub name_unique_constraint {
my ($self, $cols) = @_;
return join '_', $self->name, @$cols;
}
=head2 unique_constraints
Read-only accessor which returns the list of unique constraints on this source.
=cut
sub unique_constraints {
return %{shift->_unique_constraints||{}};
}
=head2 unique_constraint_names
Returns the list of unique constraint names defined on this source.
=cut
sub unique_constraint_names {
my ($self) = @_;
my %unique_constraints = $self->unique_constraints;
return keys %unique_constraints;
}
=head2 unique_constraint_columns
Returns the list of columns that make up the specified unique constraint.
=cut
sub unique_constraint_columns {
my ($self, $constraint_name) = @_;
my %unique_constraints = $self->unique_constraints;
$self->throw_exception(
"Unknown unique constraint $constraint_name on '" . $self->name . "'"
) unless exists $unique_constraints{$constraint_name};
return @{ $unique_constraints{$constraint_name} };
}
=head2 from
Returns an expression of the source to be supplied to storage to specify
retrieval from this source. In the case of a database, the required FROM
clause contents.
=head2 schema
Returns the L<DBIx::Class::Schema> object that this result source
belongs too.
=head2 storage
Returns the storage handle for the current schema.
See also: L<DBIx::Class::Storage>
=cut
sub storage { shift->schema->storage; }
=head2 add_relationship
$source->add_relationship('relname', 'related_source', $cond, $attrs);
The relationship name can be arbitrary, but must be unique for each
relationship attached to this result source. 'related_source' should
be the name with which the related result source was registered with
the current schema. For example:
$schema->source('Book')->add_relationship('reviews', 'Review', {
'foreign.book_id' => 'self.id',
});
The condition C<$cond> needs to be an L<SQL::Abstract>-style
representation of the join between the tables. For example, if you're
creating a rel from Author to Book,
{ 'foreign.author_id' => 'self.id' }
will result in the JOIN clause
author me JOIN book foreign ON foreign.author_id = me.id
You can specify as many foreign => self mappings as necessary.
Valid attributes are as follows:
=over 4
=item join_type
Explicitly specifies the type of join to use in the relationship. Any
SQL join type is valid, e.g. C<LEFT> or C<RIGHT>. It will be placed in
the SQL command immediately before C<JOIN>.
=item proxy
An arrayref containing a list of accessors in the foreign class to proxy in
the main class. If, for example, you do the following:
CD->might_have(liner_notes => 'LinerNotes', undef, {
proxy => [ qw/notes/ ],
});
Then, assuming LinerNotes has an accessor named notes, you can do:
my $cd = CD->find(1);
# set notes -- LinerNotes object is created if it doesn't exist
$cd->notes('Notes go here');
=item accessor
Specifies the type of accessor that should be created for the
relationship. Valid values are C<single> (for when there is only a single
related object), C<multi> (when there can be many), and C<filter> (for
when there is a single related object, but you also want the relationship
accessor to double as a column accessor). For C<multi> accessors, an
add_to_* method is also created, which calls C<create_related> for the
relationship.
=back
=cut
sub add_relationship {
my ($self, $rel, $f_source_name, $cond, $attrs) = @_;
$self->throw_exception("Can't create relationship without join condition")
unless $cond;
$attrs ||= {};
my %rels = %{ $self->_relationships };
$rels{$rel} = { class => $f_source_name,
source => $f_source_name,
cond => $cond,
attrs => $attrs };
$self->_relationships(\%rels);
return $self;
# XXX disabled. doesn't work properly currently. skip in tests.
my $f_source = $self->schema->source($f_source_name);
unless ($f_source) {
$self->ensure_class_loaded($f_source_name);
$f_source = $f_source_name->result_source;
#my $s_class = ref($self->schema);
#$f_source_name =~ m/^${s_class}::(.*)$/;
#$self->schema->register_class(($1 || $f_source_name), $f_source_name);
#$f_source = $self->schema->source($f_source_name);
}
return unless $f_source; # Can't test rel without f_source
eval { $self->resolve_join($rel, 'me') };
if ($@) { # If the resolve failed, back out and re-throw the error
delete $rels{$rel}; #
$self->_relationships(\%rels);
$self->throw_exception("Error creating relationship $rel: $@");
}
1;
}
=head2 relationships
Returns all relationship names for this source.
=cut
sub relationships {
return keys %{shift->_relationships};
}
=head2 relationship_info
=over 4
=item Arguments: $relname
=back
Returns a hash of relationship information for the specified relationship
name.
=cut
sub relationship_info {
my ($self, $rel) = @_;
return $self->_relationships->{$rel};
}
=head2 has_relationship
=over 4
=item Arguments: $rel
=back
Returns true if the source has a relationship of this name, false otherwise.
=cut
sub has_relationship {
my ($self, $rel) = @_;
return exists $self->_relationships->{$rel};
}
=head2 reverse_relationship_info
=over 4
=item Arguments: $relname
=back
Returns an array of hash references of relationship information for
the other side of the specified relationship name.
=cut
sub reverse_relationship_info {
my ($self, $rel) = @_;
my $rel_info = $self->relationship_info($rel);
my $ret = {};
return $ret unless ((ref $rel_info->{cond}) eq 'HASH');
my @cond = keys(%{$rel_info->{cond}});
my @refkeys = map {/^\w+\.(\w+)$/} @cond;
my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
# Get the related result source for this relationship
my $othertable = $self->related_source($rel);
# Get all the relationships for that source that related to this source
# whose foreign column set are our self columns on $rel and whose self
# columns are our foreign columns on $rel.
my @otherrels = $othertable->relationships();
my $otherrelationship;
foreach my $otherrel (@otherrels) {
my $otherrel_info = $othertable->relationship_info($otherrel);
my $back = $othertable->related_source($otherrel);
next unless $back->name eq $self->name;
my @othertestconds;
if (ref $otherrel_info->{cond} eq 'HASH') {
@othertestconds = ($otherrel_info->{cond});
}
elsif (ref $otherrel_info->{cond} eq 'ARRAY') {
@othertestconds = @{$otherrel_info->{cond}};
}
else {
next;
}
foreach my $othercond (@othertestconds) {
my @other_cond = keys(%$othercond);
my @other_refkeys = map {/^\w+\.(\w+)$/} @other_cond;
my @other_keys = map {$othercond->{$_} =~ /^\w+\.(\w+)$/} @other_cond;
next if (!$self->compare_relationship_keys(\@refkeys, \@other_keys) ||
!$self->compare_relationship_keys(\@other_refkeys, \@keys));
$ret->{$otherrel} = $otherrel_info;
}
}
return $ret;
}
=head2 compare_relationship_keys
=over 4
=item Arguments: $keys1, $keys2
=back
Returns true if both sets of keynames are the same, false otherwise.
=cut
sub compare_relationship_keys {
my ($self, $keys1, $keys2) = @_;
# Make sure every keys1 is in keys2
my $found;
foreach my $key (@$keys1) {
$found = 0;
foreach my $prim (@$keys2) {
if ($prim eq $key) {
$found = 1;
last;
}
}
last unless $found;
}
# Make sure every key2 is in key1
if ($found) {
foreach my $prim (@$keys2) {
$found = 0;
foreach my $key (@$keys1) {
if ($prim eq $key) {
$found = 1;
last;
}
}
last unless $found;
}
}
return $found;
}
=head2 resolve_join
=over 4
=item Arguments: $relation
=back
Returns the join structure required for the related result source.
=cut
sub resolve_join {
my ($self, $join, $alias, $seen) = @_;
$seen ||= {};
if (ref $join eq 'ARRAY') {
return map { $self->resolve_join($_, $alias, $seen) } @$join;
} elsif (ref $join eq 'HASH') {
return
map {
my $as = ($seen->{$_} ? $_.'_'.($seen->{$_}+1) : $_);
($self->resolve_join($_, $alias, $seen),
$self->related_source($_)->resolve_join($join->{$_}, $as, $seen));
} keys %$join;
} elsif (ref $join) {
$self->throw_exception("No idea how to resolve join reftype ".ref $join);
} else {
my $count = ++$seen->{$join};
#use Data::Dumper; warn Dumper($seen);
my $as = ($count > 1 ? "${join}_${count}" : $join);
my $rel_info = $self->relationship_info($join);
$self->throw_exception("No such relationship ${join}") unless $rel_info;
my $type = $rel_info->{attrs}{join_type} || '';
return [ { $as => $self->related_source($join)->from,
-join_type => $type },
$self->resolve_condition($rel_info->{cond}, $as, $alias) ];
}
}
=head2 resolve_condition
=over 4
=item Arguments: $cond, $as, $alias|$object
=back
Resolves the passed condition to a concrete query fragment. If given an alias,
returns a join condition; if given an object, inverts that object to produce
a related conditional from that object.
=cut
sub resolve_condition {
my ($self, $cond, $as, $for) = @_;
#warn %$cond;
if (ref $cond eq 'HASH') {
my %ret;
foreach my $k (keys %{$cond}) {
my $v = $cond->{$k};
# XXX should probably check these are valid columns
$k =~ s/^foreign\.// ||
$self->throw_exception("Invalid rel cond key ${k}");
$v =~ s/^self\.// ||
$self->throw_exception("Invalid rel cond val ${v}");
if (ref $for) { # Object
#warn "$self $k $for $v";
$ret{$k} = $for->get_column($v);
#warn %ret;
} elsif (!defined $for) { # undef, i.e. "no object"
$ret{$k} = undef;
} elsif (ref $as) { # reverse object
$ret{$v} = $as->get_column($k);
} elsif (!defined $as) { # undef, i.e. "no reverse object"
$ret{$v} = undef;
} else {
$ret{"${as}.${k}"} = "${for}.${v}";
}
}
return \%ret;
} elsif (ref $cond eq 'ARRAY') {
return [ map { $self->resolve_condition($_, $as, $for) } @$cond ];
} else {
die("Can't handle this yet :(");
}
}
=head2 resolve_prefetch
=over 4
=item Arguments: hashref/arrayref/scalar
=back
Accepts one or more relationships for the current source and returns an
array of column names for each of those relationships. Column names are
prefixed relative to the current source, in accordance with where they appear
in the supplied relationships. Examples:
my $source = $schema->resultset('Tag')->source;
@columns = $source->resolve_prefetch( { cd => 'artist' } );
# @columns =
#(
# 'cd.cdid',
# 'cd.artist',
# 'cd.title',
# 'cd.year',
# 'cd.artist.artistid',
# 'cd.artist.name'
#)
@columns = $source->resolve_prefetch( qw[/ cd /] );
# @columns =
#(
# 'cd.cdid',
# 'cd.artist',
# 'cd.title',
# 'cd.year'
#)
$source = $schema->resultset('CD')->source;
@columns = $source->resolve_prefetch( qw[/ artist producer /] );
# @columns =
#(
# 'artist.artistid',
# 'artist.name',
# 'producer.producerid',
# 'producer.name'
#)
=cut
sub resolve_prefetch {
my ($self, $pre, $alias, $seen, $order, $collapse) = @_;
$seen ||= {};
#$alias ||= $self->name;
#warn $alias, Dumper $pre;
if( ref $pre eq 'ARRAY' ) {
return
map { $self->resolve_prefetch( $_, $alias, $seen, $order, $collapse ) }
@$pre;
}
elsif( ref $pre eq 'HASH' ) {
my @ret =
map {
$self->resolve_prefetch($_, $alias, $seen, $order, $collapse),
$self->related_source($_)->resolve_prefetch(
$pre->{$_}, "${alias}.$_", $seen, $order, $collapse)
} keys %$pre;
#die Dumper \@ret;
return @ret;
}
elsif( ref $pre ) {
$self->throw_exception(
"don't know how to resolve prefetch reftype ".ref($pre));
}
else {
my $count = ++$seen->{$pre};
my $as = ($count > 1 ? "${pre}_${count}" : $pre);
my $rel_info = $self->relationship_info( $pre );
$self->throw_exception( $self->name . " has no such relationship '$pre'" )
unless $rel_info;
my $as_prefix = ($alias =~ /^.*?\.(.+)$/ ? $1.'.' : '');
my $rel_source = $self->related_source($pre);
if (exists $rel_info->{attrs}{accessor}
&& $rel_info->{attrs}{accessor} eq 'multi') {
$self->throw_exception(
"Can't prefetch has_many ${pre} (join cond too complex)")
unless ref($rel_info->{cond}) eq 'HASH';
my @key = map { (/^foreign\.(.+)$/ ? ($1) : ()); }
keys %{$rel_info->{cond}};
$collapse->{"${as_prefix}${pre}"} = \@key;
my @ord = (ref($rel_info->{attrs}{order_by}) eq 'ARRAY'
? @{$rel_info->{attrs}{order_by}}
: (defined $rel_info->{attrs}{order_by}
? ($rel_info->{attrs}{order_by})
: ()));
push(@$order, map { "${as}.$_" } (@key, @ord));
}
return map { [ "${as}.$_", "${as_prefix}${pre}.$_", ] }
$rel_source->columns;
#warn $alias, Dumper (\@ret);
#return @ret;
}
}
=head2 related_source
=over 4
=item Arguments: $relname
=back
Returns the result source object for the given relationship.
=cut
sub related_source {
my ($self, $rel) = @_;
if( !$self->has_relationship( $rel ) ) {
$self->throw_exception("No such relationship '$rel'");
}
return $self->schema->source($self->relationship_info($rel)->{source});
}
=head2 related_class
=over 4
=item Arguments: $relname
=back
Returns the class name for objects in the given relationship.
=cut
sub related_class {
my ($self, $rel) = @_;
if( !$self->has_relationship( $rel ) ) {
$self->throw_exception("No such relationship '$rel'");
}
return $self->schema->class($self->relationship_info($rel)->{source});
}
=head2 resultset
Returns a resultset for the given source. This will initially be created
on demand by calling
$self->resultset_class->new($self, $self->resultset_attributes)
but is cached from then on unless resultset_class changes.
=head2 resultset_class
` package My::ResultSetClass;
use base 'DBIx::Class::ResultSet';
...
$source->resultset_class('My::ResultSet::Class');
Set the class of the resultset, this is useful if you want to create your
own resultset methods. Create your own class derived from
L<DBIx::Class::ResultSet>, and set it here.
=head2 resultset_attributes
$source->resultset_attributes({ order_by => [ 'id' ] });
Specify here any attributes you wish to pass to your specialised resultset.
=cut
sub resultset {
my $self = shift;
$self->throw_exception(
'resultset does not take any arguments. If you want another resultset, '.
'call it on the schema instead.'
) if scalar @_;
# disabled until we can figure out a way to do it without consistency issues
#
#return $self->{_resultset}
# if ref $self->{_resultset} eq $self->resultset_class;
#return $self->{_resultset} =
return $self->resultset_class->new(
$self, $self->{resultset_attributes}
);
}
=head2 source_name
=over 4
=item Arguments: $source_name
=back
Set the name of the result source when it is loaded into a schema.
This is usefull if you want to refer to a result source by a name other than
its class name.
package ArchivedBooks;
use base qw/DBIx::Class/;
__PACKAGE__->table('books_archive');
__PACKAGE__->source_name('Books');
# from your schema...
$schema->resultset('Books')->find(1);
=head2 throw_exception
See L<DBIx::Class::Schema/"throw_exception">.
=cut
sub throw_exception {
my $self = shift;
if (defined $self->schema) {
$self->schema->throw_exception(@_);
} else {
croak(@_);
}
}
=head1 AUTHORS
Matt S. Trout <mst@shadowcatsystems.co.uk>
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
=cut
|