split connect_info parser out into private _normalize_connect_info
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / ResultSource / View.pm
CommitLineData
1d521afd 1package DBIx::Class::ResultSource::View;
2
3use strict;
4use warnings;
5
6use DBIx::Class::ResultSet;
7
8use base qw/DBIx::Class/;
9__PACKAGE__->load_components(qw/ResultSource/);
030c27ad 10__PACKAGE__->mk_group_accessors(
11 'simple' => qw(is_virtual view_definition)
12);
1d521afd 13
1d521afd 14=head1 NAME
15
00be2e0b 16DBIx::Class::ResultSource::View - ResultSource object representing a view
1d521afd 17
18=head1 SYNOPSIS
19
16ccb4fe 20 package MyDB::Schema::Result::Year2000CDs;
00be2e0b 21
d88ecca6 22 use base qw/DBIx::Class::Core/;
00be2e0b 23
00be2e0b 24 __PACKAGE__->table_class('DBIx::Class::ResultSource::View');
25
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'"
b4664250 30 );
31 __PACKAGE__->add_columns(
32 'cdid' => {
33 data_type => 'integer',
34 is_auto_increment => 1,
35 },
36 'artist' => {
37 data_type => 'integer',
38 },
39 'title' => {
40 data_type => 'varchar',
41 size => 100,
42 },
43 );
00be2e0b 44
1d521afd 45=head1 DESCRIPTION
46
00be2e0b 47View object that inherits from L<DBIx::Class::ResultSource>
48
b4664250 49This class extends ResultSource to add basic view support.
00be2e0b 50
b4664250 51A view has a L</view_definition>, which contains a SQL query. The query can
52only have parameters if L</is_virtual> is set to true. It may contain JOINs,
53sub selects and any other SQL your database supports.
00be2e0b 54
55View definition SQL is deployed to your database on
56L<DBIx::Class::Schema/deploy> unless you set L</is_virtual> to true.
57
58Deploying the view does B<not> translate it between different database
59syntaxes, so be careful what you write in your view SQL.
60
66d2a14e 61Virtual views (L</is_virtual> true), are assumed to not
00be2e0b 62exist in your database as a real view. The L</view_definition> in this
63case replaces the view name in a FROM clause in a subselect.
64
b4664250 65=head1 EXAMPLES
66
67Having created the MyDB::Schema::Year2000CDs schema as shown in the SYNOPSIS
68above, you can then:
69
70 $2000_cds = $schema->resultset('Year2000CDs')
71 ->search()
72 ->all();
73 $count = $schema->resultset('Year2000CDs')
74 ->search()
75 ->count();
76
77If you modified the schema to include a placeholder
78
79 __PACKAGE__->result_source_instance->view_definition(
80 "SELECT cdid, artist, title FROM cd WHERE year ='?'"
81 );
82
83and ensuring you have is_virtual set to true:
84
85 __PACKAGE__->result_source_instance->is_virtual(1);
86
87You could now say:
88
89 $2001_cds = $schema->resultset('Year2000CDs')
90 ->search({}, { bind => [2001] })
91 ->all();
92 $count = $schema->resultset('Year2000CDs')
93 ->search({}, { bind => [2001] })
94 ->count();
95
00be2e0b 96=head1 SQL EXAMPLES
97
98=over
99
66d2a14e 100=item is_virtual set to false
00be2e0b 101
102 $schema->resultset('Year2000CDs')->all();
103
104 SELECT cdid, artist, title FROM year2000cds me
105
66d2a14e 106=item is_virtual set to true
00be2e0b 107
108 $schema->resultset('Year2000CDs')->all();
109
110 SELECT cdid, artist, title FROM
111 (SELECT cdid, artist, title FROM cd WHERE year ='2000') me
112
113=back
1d521afd 114
115=head1 METHODS
116
9774f48b 117=head2 is_virtual
118
00be2e0b 119 __PACKAGE__->result_source_instance->is_virtual(1);
120
121Set to true for a virtual view, false or unset for a real
122database-based view.
123
124=head2 view_definition
125
126 __PACKAGE__->result_source_instance->view_definition(
127 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
128 );
129
130An SQL query for your view. Will not be translated across database
131syntaxes.
132
133
134=head1 OVERRIDDEN METHODS
9774f48b 135
1d521afd 136=head2 from
137
138Returns the FROM entry for the table (i.e. the view name)
00be2e0b 139or the SQL as a subselect if this is a virtual view.
1d521afd 140
141=cut
142
9774f48b 143sub from {
144 my $self = shift;
145 return \"(${\$self->view_definition})" if $self->is_virtual;
146 return $self->name;
147}
1d521afd 148
1491;
150
151=head1 AUTHORS
152
153Matt S. Trout <mst@shadowcatsystems.co.uk>
154
155With Contributions from:
156
157Guillermo Roditi E<lt>groditi@cpan.orgE<gt>
158
00be2e0b 159Jess Robinson <castaway@desert-island.me.uk>
160
66d2a14e 161Wallace Reis <wreis@cpan.org>
162
1d521afd 163=head1 LICENSE
164
165You may distribute this code under the same terms as Perl itself.
166
167=cut
168