NAME

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

SYNOPSIS

  package MyDB::Schema::Year2000CDs;

  use DBIx::Class::ResultSource::View;

  __PACKAGE__->load_components('Core');
  __PACKAGE__->table_class('DBIx::Class::ResultSource::View');

  __PACKAGE__->table('year2000cds');
  __PACKAGE__->result_source_instance->is_virtual(1);
  __PACKAGE__->result_source_instance->view_definition(
      "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
      );

DESCRIPTION

View object that inherits from DBIx::Class::ResultSource

This class extends ResultSource to add basic view support.

A view has a "view_definition", which contains an SQL query. The query cannot have parameters. It may contain JOINs, sub selects and any other SQL your database supports.

View definition SQL is deployed to your database on "deploy" in DBIx::Class::Schema unless you set "is_virtual" to true.

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

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

SQL EXAMPLES

is_virtual set to false

  $schema->resultset('Year2000CDs')->all();

  SELECT cdid, artist, title FROM year2000cds me

is_virtual set to true

  $schema->resultset('Year2000CDs')->all();

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

METHODS

is_virtual

  __PACKAGE__->result_source_instance->is_virtual(1);

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

view_definition

  __PACKAGE__->result_source_instance->view_definition(
      "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
      );

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

OVERRIDDEN METHODS

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.

AUTHORS

Matt S. Trout <mst@shadowcatsystems.co.uk>

With Contributions from:

Guillermo Roditi <groditi@cpan.org>

Jess Robinson <castaway@desert-island.me.uk>

Wallace Reis <wreis@cpan.org>

LICENSE

You may distribute this code under the same terms as Perl itself.

cpanm DBIx::Class

perl -MCPAN -e shell
install DBIx::Class