lib/DBIx/Class/ResultSource/View.pm

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