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)
16 DBIx::Class::ResultSource::View - ResultSource object representing a view
20 package MyDB::Schema::Result::Year2000CDs;
22 use base qw/DBIx::Class/;
23 use DBIx::Class::ResultSource::View;
25 __PACKAGE__->load_components('Core');
26 __PACKAGE__->table_class('DBIx::Class::ResultSource::View');
28 __PACKAGE__->table('year2000cds');
29 __PACKAGE__->result_source_instance->is_virtual(1);
30 __PACKAGE__->result_source_instance->view_definition(
31 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
33 __PACKAGE__->add_columns(
35 data_type => 'integer',
36 is_auto_increment => 1,
39 data_type => 'integer',
42 data_type => 'varchar',
49 View object that inherits from L<DBIx::Class::ResultSource>
51 This class extends ResultSource to add basic view support.
53 A view has a L</view_definition>, which contains a SQL query. The query can
54 only have parameters if L</is_virtual> is set to true. It may contain JOINs,
55 sub selects and any other SQL your database supports.
57 View definition SQL is deployed to your database on
58 L<DBIx::Class::Schema/deploy> unless you set L</is_virtual> to true.
60 Deploying the view does B<not> translate it between different database
61 syntaxes, so be careful what you write in your view SQL.
63 Virtual views (L</is_virtual> true), are assumed to not
64 exist in your database as a real view. The L</view_definition> in this
65 case replaces the view name in a FROM clause in a subselect.
69 Having created the MyDB::Schema::Year2000CDs schema as shown in the SYNOPSIS
72 $2000_cds = $schema->resultset('Year2000CDs')
75 $count = $schema->resultset('Year2000CDs')
79 If you modified the schema to include a placeholder
81 __PACKAGE__->result_source_instance->view_definition(
82 "SELECT cdid, artist, title FROM cd WHERE year ='?'"
85 and ensuring you have is_virtual set to true:
87 __PACKAGE__->result_source_instance->is_virtual(1);
91 $2001_cds = $schema->resultset('Year2000CDs')
92 ->search({}, { bind => [2001] })
94 $count = $schema->resultset('Year2000CDs')
95 ->search({}, { bind => [2001] })
102 =item is_virtual set to false
104 $schema->resultset('Year2000CDs')->all();
106 SELECT cdid, artist, title FROM year2000cds me
108 =item is_virtual set to true
110 $schema->resultset('Year2000CDs')->all();
112 SELECT cdid, artist, title FROM
113 (SELECT cdid, artist, title FROM cd WHERE year ='2000') me
121 __PACKAGE__->result_source_instance->is_virtual(1);
123 Set to true for a virtual view, false or unset for a real
126 =head2 view_definition
128 __PACKAGE__->result_source_instance->view_definition(
129 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
132 An SQL query for your view. Will not be translated across database
136 =head1 OVERRIDDEN METHODS
140 Returns the FROM entry for the table (i.e. the view name)
141 or the SQL as a subselect if this is a virtual view.
147 return \"(${\$self->view_definition})" if $self->is_virtual;
155 Matt S. Trout <mst@shadowcatsystems.co.uk>
157 With Contributions from:
159 Guillermo Roditi E<lt>groditi@cpan.orgE<gt>
161 Jess Robinson <castaway@desert-island.me.uk>
163 Wallace Reis <wreis@cpan.org>
167 You may distribute this code under the same terms as Perl itself.