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 depends_on)
15 my $new = shift->next::method(@_);
16 $new->{depends_on} = { %{$new->{depends_on}||{}} };
22 DBIx::Class::ResultSource::View - ResultSource object representing a view
26 package MyDB::Schema::Result::Year2000CDs;
28 use base qw/DBIx::Class::Core/;
30 __PACKAGE__->table_class('DBIx::Class::ResultSource::View');
32 __PACKAGE__->table('year2000cds');
33 __PACKAGE__->result_source_instance->is_virtual(1);
34 __PACKAGE__->result_source_instance->view_definition(
35 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
37 __PACKAGE__->add_columns(
39 data_type => 'integer',
40 is_auto_increment => 1,
43 data_type => 'integer',
46 data_type => 'varchar',
53 View object that inherits from L<DBIx::Class::ResultSource>
55 This class extends ResultSource to add basic view support.
57 A view has a L</view_definition>, which contains a SQL query. The query can
58 only have parameters if L</is_virtual> is set to true. It may contain JOINs,
59 sub selects and any other SQL your database supports.
61 View definition SQL is deployed to your database on
62 L<DBIx::Class::Schema/deploy> unless you set L</is_virtual> to true.
64 Deploying the view does B<not> translate it between different database
65 syntaxes, so be careful what you write in your view SQL.
67 Virtual views (L</is_virtual> true), are assumed to not
68 exist in your database as a real view. The L</view_definition> in this
69 case replaces the view name in a FROM clause in a subselect.
73 Having created the MyDB::Schema::Year2000CDs schema as shown in the SYNOPSIS
76 $2000_cds = $schema->resultset('Year2000CDs')
79 $count = $schema->resultset('Year2000CDs')
83 If you modified the schema to include a placeholder
85 __PACKAGE__->result_source_instance->view_definition(
86 "SELECT cdid, artist, title FROM cd WHERE year ='?'"
89 and ensuring you have is_virtual set to true:
91 __PACKAGE__->result_source_instance->is_virtual(1);
95 $2001_cds = $schema->resultset('Year2000CDs')
96 ->search({}, { bind => [2001] })
98 $count = $schema->resultset('Year2000CDs')
99 ->search({}, { bind => [2001] })
106 =item is_virtual set to false
108 $schema->resultset('Year2000CDs')->all();
110 SELECT cdid, artist, title FROM year2000cds me
112 =item is_virtual set to true
114 $schema->resultset('Year2000CDs')->all();
116 SELECT cdid, artist, title FROM
117 (SELECT cdid, artist, title FROM cd WHERE year ='2000') me
125 __PACKAGE__->result_source_instance->is_virtual(1);
127 Set to true for a virtual view, false or unset for a real
130 =head2 view_definition
132 __PACKAGE__->result_source_instance->view_definition(
133 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
136 An SQL query for your view. Will not be translated across database
140 =head1 OVERRIDDEN METHODS
144 Returns the FROM entry for the table (i.e. the view name)
145 or the SQL as a subselect if this is a virtual view.
151 return \"(${\$self->view_definition})" if $self->is_virtual;
159 Matt S. Trout <mst@shadowcatsystems.co.uk>
161 With Contributions from:
163 Guillermo Roditi E<lt>groditi@cpan.orgE<gt>
165 Jess Robinson <castaway@desert-island.me.uk>
167 Wallace Reis <wreis@cpan.org>
171 You may distribute this code under the same terms as Perl itself.