use strict;
use warnings;
-use DBIx::Class::ResultSet;
+use base 'DBIx::Class::ResultSource';
-use base qw/DBIx::Class/;
-__PACKAGE__->load_components(qw/ResultSource/);
__PACKAGE__->mk_group_accessors(
- 'simple' => qw(is_virtual view_definition)
-);
+ 'simple' => qw(is_virtual view_definition deploy_depends_on) );
=head1 NAME
=head1 SYNOPSIS
- package MyDB::Schema::Year2000CDs;
+ package MyApp::Schema::Result::Year2000CDs;
- use DBIx::Class::ResultSource::View;
+ use base qw/DBIx::Class::Core/;
- __PACKAGE__->load_components('Core');
__PACKAGE__->table_class('DBIx::Class::ResultSource::View');
__PACKAGE__->table('year2000cds');
- __PACKAGE__->result_source_instance->is_virtual(1);
- __PACKAGE__->result_source_instance->view_definition(
+ __PACKAGE__->result_source->is_virtual(1);
+ __PACKAGE__->result_source->view_definition(
"SELECT cdid, artist, title FROM cd WHERE year ='2000'"
- );
+ );
+ __PACKAGE__->add_columns(
+ 'cdid' => {
+ data_type => 'integer',
+ is_auto_increment => 1,
+ },
+ 'artist' => {
+ data_type => 'integer',
+ },
+ 'title' => {
+ data_type => 'varchar',
+ size => 100,
+ },
+ );
=head1 DESCRIPTION
View object that inherits from L<DBIx::Class::ResultSource>
-This class extends ResultSource to add basic view support.
+This class extends ResultSource to add basic view support.
-A view has a L</view_definition>, which contains an SQL query. The
-query cannot have parameters. It may contain JOINs, sub selects and
-any other SQL your database supports.
+A view has a L</view_definition>, which contains a SQL query. The query can
+only have parameters if L</is_virtual> is set to true. It may contain JOINs,
+sub selects and any other SQL your database supports.
View definition SQL is deployed to your database on
L<DBIx::Class::Schema/deploy> unless you set L</is_virtual> to true.
Deploying the view does B<not> translate it between different database
syntaxes, so be careful what you write in your view SQL.
-Virtual views (L</is_virtual> unset or false), are assumed to not
+Virtual views (L</is_virtual> true), are assumed to not
exist in your database as a real view. The L</view_definition> in this
case replaces the view name in a FROM clause in a subselect.
+=head1 EXAMPLES
+
+Having created the MyApp::Schema::Year2000CDs schema as shown in the SYNOPSIS
+above, you can then:
+
+ $y2000_cds = $schema->resultset('Year2000CDs')
+ ->search()
+ ->all();
+ $count = $schema->resultset('Year2000CDs')
+ ->search()
+ ->count();
+
+If you modified the schema to include a placeholder
+
+ __PACKAGE__->result_source->view_definition(
+ "SELECT cdid, artist, title FROM cd WHERE year = ?"
+ );
+
+and ensuring you have is_virtual set to true:
+
+ __PACKAGE__->result_source->is_virtual(1);
+
+You could now say:
+
+ $y2001_cds = $schema->resultset('Year2000CDs')
+ ->search({}, { bind => [2001] })
+ ->all();
+ $count = $schema->resultset('Year2000CDs')
+ ->search({}, { bind => [2001] })
+ ->count();
+
=head1 SQL EXAMPLES
=over
-=item is_virtual set to true
+=item is_virtual set to false
$schema->resultset('Year2000CDs')->all();
SELECT cdid, artist, title FROM year2000cds me
-=item is_virtual set to false
+=item is_virtual set to true
$schema->resultset('Year2000CDs')->all();
- SELECT cdid, artist, title FROM
+ SELECT cdid, artist, title FROM
(SELECT cdid, artist, title FROM cd WHERE year ='2000') me
=back
=head2 is_virtual
- __PACKAGE__->result_source_instance->is_virtual(1);
+ __PACKAGE__->result_source->is_virtual(1);
Set to true for a virtual view, false or unset for a real
database-based view.
=head2 view_definition
- __PACKAGE__->result_source_instance->view_definition(
+ __PACKAGE__->result_source->view_definition(
"SELECT cdid, artist, title FROM cd WHERE year ='2000'"
);
An SQL query for your view. Will not be translated across database
syntaxes.
+=head2 deploy_depends_on
+
+ __PACKAGE__->result_source->deploy_depends_on(
+ ["MyApp::Schema::Result::Year","MyApp::Schema::Result::CD"]
+ );
+
+Specify the views (and only the views) that this view depends on.
+Pass this an array reference of fully qualified result classes.
=head1 OVERRIDDEN METHODS
=cut
sub from {
- my $self = shift;
- return \"(${\$self->view_definition})" if $self->is_virtual;
- return $self->name;
+ $_[0]->throw_exception('from() is not a setter method') if @_ > 1;
+ $_[0]->is_virtual
+ ? \( '(' . $_[0]->view_definition .')' )
+ : $_[0]->name
+ ;
}
-1;
+=head1 OTHER METHODS
-=head1 AUTHORS
+=head2 new
-Matt S. Trout <mst@shadowcatsystems.co.uk>
+The constructor.
-With Contributions from:
+=cut
-Guillermo Roditi E<lt>groditi@cpan.orgE<gt>
+sub new {
+ my ( $self, @args ) = @_;
+ my $new = $self->next::method(@args);
+ $new->{deploy_depends_on} =
+ { map { $_ => 1 }
+ @{ $new->{deploy_depends_on} || [] } }
+ unless ref $new->{deploy_depends_on} eq 'HASH';
+ return $new;
+}
-Jess Robinson <castaway@desert-island.me.uk>
+=head1 FURTHER QUESTIONS?
-=head1 LICENSE
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
-You may distribute this code under the same terms as Perl itself.
+=head1 COPYRIGHT AND LICENSE
+
+This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
+by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
+redistribute it and/or modify it under the same terms as the
+L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
=cut
+1;