package DBIx::Class::ResultSource::View;

use strict;
use warnings;

use DBIx::Class::ResultSet;

use base qw/DBIx::Class/;
    'simple' => qw(is_virtual view_definition deploy_depends_on) );

=head1 NAME

DBIx::Class::ResultSource::View - ResultSource object representing a view


  package MyApp::Schema::Result::Year2000CDs;

  use base qw/DBIx::Class::Core/;


      "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
    'cdid' => {
      data_type => 'integer',
      is_auto_increment => 1,
    'artist' => {
      data_type => 'integer',
    'title' => {
      data_type => 'varchar',
      size      => 100,


View object that inherits from L<DBIx::Class::ResultSource>

This class extends ResultSource to add basic view support.

A view has a L</view_definition>, which contains a SQL query. The query can
only have parameters if L</is_virtual> is set to true. It may contain JOINs,
sub selects and any other SQL your database supports.

View definition SQL is deployed to your database on
L<DBIx::Class::Schema/deploy> unless you set L</is_virtual> to true.

Deploying the view does B<not> translate it between different database
syntaxes, so be careful what you write in your view SQL.

Virtual views (L</is_virtual> true), are assumed to not
exist in your database as a real view. The L</view_definition> in this
case replaces the view name in a FROM clause in a subselect.


Having created the MyApp::Schema::Year2000CDs schema as shown in the SYNOPSIS
above, you can then:

  $2000_cds = $schema->resultset('Year2000CDs')
  $count    = $schema->resultset('Year2000CDs')

If you modified the schema to include a placeholder

      "SELECT cdid, artist, title FROM cd WHERE year = ?"

and ensuring you have is_virtual set to true:


You could now say:

  $2001_cds = $schema->resultset('Year2000CDs')
                     ->search({}, { bind => [2001] })
  $count    = $schema->resultset('Year2000CDs')
                     ->search({}, { bind => [2001] })



=item is_virtual set to false


  SELECT cdid, artist, title FROM year2000cds me

=item is_virtual set to true


  SELECT cdid, artist, title FROM
    (SELECT cdid, artist, title FROM cd WHERE year ='2000') me


=head1 METHODS

=head2 is_virtual


Set to true for a virtual view, false or unset for a real
database-based view.

=head2 view_definition

      "SELECT cdid, artist, title FROM cd WHERE year ='2000'"

An SQL query for your view. Will not be translated across database

=head2 deploy_depends_on


Specify the views (and only the views) that this view depends on.
Pass this an array reference of fully qualified result classes.


=head2 from

Returns the FROM entry for the table (i.e. the view name)
or the SQL as a subselect if this is a virtual view.


sub from {
    my $self = shift;
    return \"(${\$self->view_definition})" if $self->is_virtual;
    return $self->name;


=head2 new

The constructor.


sub new {
    my ( $self, @args ) = @_;
    my $new = $self->next::method(@args);
    $new->{deploy_depends_on} =
      { map { $_ => 1 }
          @{ $new->{deploy_depends_on} || [] } }
      unless ref $new->{deploy_depends_on} eq 'HASH';
    return $new;


Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.


This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
redistribute it and/or modify it under the same terms as the
L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.