1 package DBIx::Class::ResultSource::View;
6 use DBIx::Class::ResultSet;
8 use base qw/DBIx::Class/;
9 __PACKAGE__->load_components(qw/ResultSource/);
10 __PACKAGE__->mk_group_accessors(
11 'simple' => qw(is_virtual view_definition deploy_depends_on) );
15 DBIx::Class::ResultSource::View - ResultSource object representing a view
19 package MyApp::Schema::Result::Year2000CDs;
21 use base qw/DBIx::Class::Core/;
23 __PACKAGE__->table_class('DBIx::Class::ResultSource::View');
25 __PACKAGE__->table('year2000cds');
26 __PACKAGE__->result_source_instance->is_virtual(1);
27 __PACKAGE__->result_source_instance->view_definition(
28 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
30 __PACKAGE__->add_columns(
32 data_type => 'integer',
33 is_auto_increment => 1,
36 data_type => 'integer',
39 data_type => 'varchar',
46 View object that inherits from L<DBIx::Class::ResultSource>
48 This class extends ResultSource to add basic view support.
50 A view has a L</view_definition>, which contains a SQL query. The query can
51 only have parameters if L</is_virtual> is set to true. It may contain JOINs,
52 sub selects and any other SQL your database supports.
54 View definition SQL is deployed to your database on
55 L<DBIx::Class::Schema/deploy> unless you set L</is_virtual> to true.
57 Deploying the view does B<not> translate it between different database
58 syntaxes, so be careful what you write in your view SQL.
60 Virtual views (L</is_virtual> true), are assumed to not
61 exist in your database as a real view. The L</view_definition> in this
62 case replaces the view name in a FROM clause in a subselect.
66 Having created the MyApp::Schema::Year2000CDs schema as shown in the SYNOPSIS
69 $y2000_cds = $schema->resultset('Year2000CDs')
72 $count = $schema->resultset('Year2000CDs')
76 If you modified the schema to include a placeholder
78 __PACKAGE__->result_source_instance->view_definition(
79 "SELECT cdid, artist, title FROM cd WHERE year = ?"
82 and ensuring you have is_virtual set to true:
84 __PACKAGE__->result_source_instance->is_virtual(1);
88 $y2001_cds = $schema->resultset('Year2000CDs')
89 ->search({}, { bind => [2001] })
91 $count = $schema->resultset('Year2000CDs')
92 ->search({}, { bind => [2001] })
99 =item is_virtual set to false
101 $schema->resultset('Year2000CDs')->all();
103 SELECT cdid, artist, title FROM year2000cds me
105 =item is_virtual set to true
107 $schema->resultset('Year2000CDs')->all();
109 SELECT cdid, artist, title FROM
110 (SELECT cdid, artist, title FROM cd WHERE year ='2000') me
118 __PACKAGE__->result_source_instance->is_virtual(1);
120 Set to true for a virtual view, false or unset for a real
123 =head2 view_definition
125 __PACKAGE__->result_source_instance->view_definition(
126 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
129 An SQL query for your view. Will not be translated across database
132 =head2 deploy_depends_on
134 __PACKAGE__->result_source_instance->deploy_depends_on(
135 ["MyApp::Schema::Result::Year","MyApp::Schema::Result::CD"]
138 Specify the views (and only the views) that this view depends on.
139 Pass this an array reference of fully qualified result classes.
141 =head1 OVERRIDDEN METHODS
145 Returns the FROM entry for the table (i.e. the view name)
146 or the SQL as a subselect if this is a virtual view.
151 $_[0]->throw_exception('from() is not a setter method') if @_ > 1;
153 ? \( '(' . $_[0]->view_definition .')' )
167 my ( $self, @args ) = @_;
168 my $new = $self->next::method(@args);
169 $new->{deploy_depends_on} =
171 @{ $new->{deploy_depends_on} || [] } }
172 unless ref $new->{deploy_depends_on} eq 'HASH';
176 =head1 FURTHER QUESTIONS?
178 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
180 =head1 COPYRIGHT AND LICENSE
182 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
183 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
184 redistribute it and/or modify it under the same terms as the
185 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.