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::Core/;
24 __PACKAGE__->table_class('DBIx::Class::ResultSource::View');
26 __PACKAGE__->table('year2000cds');
27 __PACKAGE__->result_source_instance->is_virtual(1);
28 __PACKAGE__->result_source_instance->view_definition(
29 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
31 __PACKAGE__->add_columns(
33 data_type => 'integer',
34 is_auto_increment => 1,
37 data_type => 'integer',
40 data_type => 'varchar',
47 View object that inherits from L<DBIx::Class::ResultSource>
49 This class extends ResultSource to add basic view support.
51 A view has a L</view_definition>, which contains a SQL query. The query can
52 only have parameters if L</is_virtual> is set to true. It may contain JOINs,
53 sub selects and any other SQL your database supports.
55 View definition SQL is deployed to your database on
56 L<DBIx::Class::Schema/deploy> unless you set L</is_virtual> to true.
58 Deploying the view does B<not> translate it between different database
59 syntaxes, so be careful what you write in your view SQL.
61 Virtual views (L</is_virtual> true), are assumed to not
62 exist in your database as a real view. The L</view_definition> in this
63 case replaces the view name in a FROM clause in a subselect.
67 Having created the MyDB::Schema::Year2000CDs schema as shown in the SYNOPSIS
70 $2000_cds = $schema->resultset('Year2000CDs')
73 $count = $schema->resultset('Year2000CDs')
77 If you modified the schema to include a placeholder
79 __PACKAGE__->result_source_instance->view_definition(
80 "SELECT cdid, artist, title FROM cd WHERE year ='?'"
83 and ensuring you have is_virtual set to true:
85 __PACKAGE__->result_source_instance->is_virtual(1);
89 $2001_cds = $schema->resultset('Year2000CDs')
90 ->search({}, { bind => [2001] })
92 $count = $schema->resultset('Year2000CDs')
93 ->search({}, { bind => [2001] })
100 =item is_virtual set to false
102 $schema->resultset('Year2000CDs')->all();
104 SELECT cdid, artist, title FROM year2000cds me
106 =item is_virtual set to true
108 $schema->resultset('Year2000CDs')->all();
110 SELECT cdid, artist, title FROM
111 (SELECT cdid, artist, title FROM cd WHERE year ='2000') me
119 __PACKAGE__->result_source_instance->is_virtual(1);
121 Set to true for a virtual view, false or unset for a real
124 =head2 view_definition
126 __PACKAGE__->result_source_instance->view_definition(
127 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
130 An SQL query for your view. Will not be translated across database
134 =head1 OVERRIDDEN METHODS
138 Returns the FROM entry for the table (i.e. the view name)
139 or the SQL as a subselect if this is a virtual view.
145 return \"(${\$self->view_definition})" if $self->is_virtual;
153 Matt S. Trout <mst@shadowcatsystems.co.uk>
155 With Contributions from:
157 Guillermo Roditi E<lt>groditi@cpan.orgE<gt>
159 Jess Robinson <castaway@desert-island.me.uk>
161 Wallace Reis <wreis@cpan.org>
165 You may distribute this code under the same terms as Perl itself.