X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSource.pm;h=5def68f0305a48957c5c320fb46e11337bae7018;hb=fc69fea6a8923cb40755446f1bb914174f53114c;hp=753bc4585c3afed836bc5c7c57f332c30f6113c4;hpb=9c992ba153ecd3a1c4421ee72018bbca7820606b;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSource.pm b/lib/DBIx/Class/ResultSource.pm index 753bc45..5def68f 100644 --- a/lib/DBIx/Class/ResultSource.pm +++ b/lib/DBIx/Class/ResultSource.pm @@ -4,14 +4,15 @@ use strict; use warnings; use DBIx::Class::ResultSet; +use Carp::Clan qw/^DBIx::Class/; -use Carp qw/croak/; +use Storable; use base qw/DBIx::Class/; __PACKAGE__->load_components(qw/AccessorGroup/); __PACKAGE__->mk_group_accessors('simple' => - qw/_columns _primaries name resultset_class result_class schema from/); + qw/_ordered_columns _columns _primaries _unique_constraints name resultset_class result_class schema from _relationships/); =head1 NAME @@ -33,16 +34,31 @@ sub new { $class = ref $class if ref $class; my $new = bless({ %{$attrs || {}} }, $class); $new->{resultset_class} ||= 'DBIx::Class::ResultSet'; - $new->{_columns} ||= {}; + $new->{_ordered_columns} = [ @{$new->{_ordered_columns}||[]}]; + $new->{_columns} = { %{$new->{_columns}||{}} }; + $new->{_relationships} = { %{$new->{_relationships}||{}} }; $new->{name} ||= "!!NAME NOT SET!!"; return $new; } sub add_columns { my ($self, @cols) = @_; + $self->_ordered_columns( \@cols ) + if !$self->_ordered_columns; + my @added; + my $columns = $self->_columns; while (my $col = shift @cols) { - $self->_columns->{$col} = (ref $cols[0] ? shift : {}); + + my $column_info = ref $cols[0] ? shift(@cols) : {}; + # If next entry is { ... } use that for the column info, if not + # use an empty hashref + + push(@added, $col) unless exists $columns->{$col}; + + $columns->{$col} = $column_info; } + push @{ $self->_ordered_columns }, @added; + return $self; } *add_column = \&add_columns; @@ -69,8 +85,8 @@ sub resultset { return $self->resultset_class->new($self); } -=head2 has_column - +=head2 has_column + if ($obj->has_column($col)) { ... } Returns 1 if the source has a column of this name, 0 otherwise. @@ -92,48 +108,104 @@ Returns the column metadata hashref for a column. sub column_info { my ($self, $column) = @_; - croak "No such column $column" unless exists $self->_columns->{$column}; + $self->throw_exception("No such column $column") + unless exists $self->_columns->{$column}; + if ( (! $self->_columns->{$column}->{data_type}) + && $self->schema && $self->storage() ){ + my $info; +############ eval for the case of storage without table + eval{ + $info = $self->storage->columns_info_for ( $self->from() ); + }; + if ( ! $@ ){ + for my $col ( keys %{$self->_columns} ){ + for my $i ( keys %{$info->{$col}} ){ + $self->_columns()->{$col}->{$i} = $info->{$col}->{$i}; + } + } + } + } return $self->_columns->{$column}; } =head2 columns - my @column_names = $obj->columns; - -=cut + my @column_names = $obj->columns; + +Returns all column names in the order they were declared to add_columns + +=cut sub columns { - croak "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1); - return keys %{shift->_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 set_primary_key(@cols) - +=head2 set_primary_key(@cols) + Defines one or more columns as primary key for this source. Should be called after C. - -=cut + +Additionally, defines a unique constraint named C. + +=cut sub set_primary_key { my ($self, @cols) = @_; # check if primary key columns are valid columns for (@cols) { - $self->throw("No such column $_ on table ".$self->name) + $self->throw_exception("No such column $_ on table ".$self->name) unless $self->has_column($_); } $self->_primaries(\@cols); + + $self->add_unique_constraint(primary => \@cols); } -=head2 primary_columns - +=head2 primary_columns + Read-only accessor which returns the list of primary keys. - -=cut + +=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 e.g. UNIQUE (column1, column2) + __PACKAGE__->add_unique_constraint(constraint_name => [ qw/column1 column2/ ]); + +=cut + +sub add_unique_constraint { + my ($self, $name, $cols) = @_; + + for (@$cols) { + $self->throw_exception("No such column $_ on table ".$self->name) + unless $self->has_column($_); + } + + my %unique_constraints = $self->unique_constraints; + $unique_constraints{$name} = $cols; + $self->_unique_constraints(\%unique_constraints); +} + +=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 from Returns an expression of the source to be supplied to storage to specify @@ -150,8 +222,298 @@ Returns the storage handle for the current schema sub storage { shift->schema->storage; } +=head2 add_relationship + + $source->add_relationship('relname', 'related_source', $cond, $attrs); + +The relation 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 simple schemas this is usally either Some::Namespace::Foo or just Foo) + +The condition needs to be an SQL::Abstract-style representation of the join +between the tables. For example, if you're creating a rel from Foo to Bar, + + { 'foreign.foo_id' => 'self.id' } + +will result in the JOIN clause + + foo me JOIN bar bar ON bar.foo_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 or C. It will be placed in the SQL +command immediately before C. + +=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: + + __PACKAGE__->might_have(bar => 'Bar', undef, { proxy => [ qw/margle/ ] }); + +Then, assuming Bar has an accessor named margle, you can do: + + my $obj = Foo->find(1); + $obj->margle(10); # set margle; Bar object is created if it doesn't exist + +=item accessor + +Specifies the type of accessor that should be created for the relationship. +Valid values are C (for when there is only a single related object), +C (when there can be many), and C (for when there is a single +related object, but you also want the relationship accessor to double as +a column accessor). For C accessors, an add_to_* method is also +created, which calls C 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) { + eval "require $f_source_name;"; + if ($@) { + die $@ unless $@ =~ /Can't locate/; + } + $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 valid relationship names for this source + +=cut + +sub relationships { + return keys %{shift->_relationships}; +} + +=head2 relationship_info($relname) + +Returns the relationship information for the specified relationship name + +=cut + +sub relationship_info { + my ($self, $rel) = @_; + return $self->_relationships->{$rel}; +} + +=head2 has_relationship($rel) + +Returns 1 if the source has a relationship of this name, 0 otherwise. + +=cut + +sub has_relationship { + my ($self, $rel) = @_; + return exists $self->_relationships->{$rel}; +} + +=head2 resolve_join($relation) + +Returns the join structure required for the related result source + +=cut + +sub resolve_join { + my ($self, $join, $alias) = @_; + if (ref $join eq 'ARRAY') { + return map { $self->resolve_join($_, $alias) } @$join; + } elsif (ref $join eq 'HASH') { + return map { $self->resolve_join($_, $alias), + $self->related_source($_)->resolve_join($join->{$_}, $_) } + keys %$join; + } elsif (ref $join) { + $self->throw_exception("No idea how to resolve join reftype ".ref $join); + } else { + 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 [ { $join => $self->related_source($join)->from, + -join_type => $type }, + $self->resolve_condition($rel_info->{cond}, $join, $alias) ]; + } +} + +=head2 resolve_condition($cond, $rel, $alias|$object) + +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, $rel, $for) = @_; + #warn %$cond; + if (ref $cond eq 'HASH') { + my %ret; + while (my ($k, $v) = each %{$cond}) { + # 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; + } else { + $ret{"${rel}.${k}"} = "${for}.${v}"; + } + } + return \%ret; + } elsif (ref $cond eq 'ARRAY') { + return [ map { $self->resolve_condition($_, $rel, $for) } @$cond ]; + } else { + die("Can't handle this yet :("); + } +} + +=head2 resolve_prefetch (hashref/arrayref/scalar) + +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 ) = @_; + use Data::Dumper; + #$alias ||= $self->name; + #warn $alias, Dumper $pre; + if( ref $pre eq 'ARRAY' ) { + return map { $self->resolve_prefetch( $_, $alias ) } @$pre; + } + elsif( ref $pre eq 'HASH' ) { + my @ret = + map { + $self->resolve_prefetch($_, $alias), + $self->related_source($_)->resolve_prefetch( $pre->{$_}, $_ ) + } + 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 $rel_info = $self->relationship_info( $pre ); + $self->throw_exception( $self->name . " has no such relationship '$pre'" ) unless $rel_info; + my $prefix = $alias && $alias ne 'me' ? "$alias.$pre" : $pre; + my @ret = map { "$prefix.$_" } $self->related_source($pre)->columns; + #warn $alias, Dumper (\@ret); + return @ret; + } +} + +=head2 related_source($relname) + +Returns the result source 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}); +} + 1; +=head2 throw_exception + +See schema's throw_exception + +=cut + +sub throw_exception { + my $self = shift; + if (defined $self->schema) { + $self->schema->throw_exception(@_); + } else { + croak(@_); + } +} + + =head1 AUTHORS Matt S. Trout