dbix::class::schema::kiokudb(3pm) [debian man page]

DBIx::Class::Schema::KiokuDB(3pm)			User Contributed Perl Documentation			 DBIx::Class::Schema::KiokuDB(3pm)

NAME

       DBIx::Class::Schema::KiokuDB - Hybrid KiokuDB/DBIx::Class::Schema schema support.

SYNOPSIS

       Load this component into the schema:

	   package MyApp::DB;
	   use base qw(DBIx::Class::Schema);

	   __PACKAGE__->load_components(qw(Schema::KiokuDB));

	   __PAKCAGE__->load_namespaces;

       Then load the DBIx::Class::KiokuDB component into every table that wants to refer to arbitrary KiokuDB objects:

	   package MyApp::DB::Result::Album;
	   use base qw(DBIx::Class::Core);

	   __PACKAGE__->load_components(qw(KiokuDB));

	   __PACKAGE__->table('album');

	   __PACKAGE__->add_columns(
	       id => { data_type => "integer" },
	       title => { data_type => "varchar" },

	       # the foreign key for the KiokuDB object:
	       metadata => { data_type => "varchar" },
	   );

	   __PACKAGE__->set_primary_key('id');

	   # enable a KiokuDB rel on the column:
	   __PACKAGE__->kiokudb_column('metadata');

       Connect to the DSN:

	   my $dir = KiokuDB->connect(
	       'dbi:SQLite:dbname=:memory:',
	       schema => "MyApp::DB",
	       create => 1,
	   );

	   # get the connect DBIC schema instance
	   my $schema = $dir->backend->schema;

       Then you can freely refer to KiokuDB objects from your "Album" class:

	   $dir->txn_do(scope => 1, body => sub {

	       $schema->resultset("Album")->create({
		   title => "Blah blah",
		   metadata => $any_object,
	       });
	   });

DESCRIPTION

       This class provides the schema definition support code required for integrating an arbitrary DBIx::Class::Schema with
       KiokuDB::Backend::DBI.

   REUSING AN EXISTING DBIx::Class SCHEMA
       The example in the Synopis assumes that you want to first set up a KiokuDB and than link that to some DBIx::Class classes. Another use case
       is that you already have a configured DBIx::Class Schema and want to tack KiokuDB onto it.

       The trick here is to make sure to load the KiokuDB schema using "__PACKAGE__->define_kiokudb_schema()" in your Schema class:

	   package MyApp::DB;
	   use base qw(DBIx::Class::Schema);

	   __PACKAGE__->load_components(qw(Schema::KiokuDB));
	   __PACKAGE__->define_kiokudb_schema();

	   __PAKCAGE__->load_namespaces;

       You can now get the KiokuDB directory handle like so:

	   my $dir = $schema->kiokudb_handle;

       For a complete example take a look at t/autovivify_handle.t.

USAGE AND LIMITATIONS

       KiokuDB managed objects may hold references to row objects, resultsets (treated as saved searches, or results or cursor state is saved),
       result source handles, and the schema.

       Foreign DBIx::Class objects, that is ones that originated from a schema that isn't the underlying schema are currently not supported, but
       this limitation may be lifted in the future.

       All DBIC operations which may implicitly cause a lookup of a KIokuDB managed object require live object scope management, just as normal.

       It is reccomended to use "txn_do" in KiokuDB because that will invoke the appropriate transaction hooks on both layers, as opposed to just
       in DBIx::Class.

SEE ALSO

       DBIx::Class::KiokuDB, KiokuDB::Backend::DBI.

perl v5.12.4							    2011-10-04					 DBIx::Class::Schema::KiokuDB(3pm)

DBIx::Class::ResultSource::View(3pm)			User Contributed Perl Documentation		      DBIx::Class::ResultSource::View(3pm)

NAME

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

SYNOPSIS

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

	 use base qw/DBIx::Class::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'"
	 );
	 __PACKAGE__->add_columns(
	   'cdid' => {
	     data_type => 'integer',
	     is_auto_increment => 1,
	   },
	   'artist' => {
	     data_type => 'integer',
	   },
	   'title' => {
	     data_type => 'varchar',
	     size      => 100,
	   },
	 );

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 a SQL query. The query can only have parameters if "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 "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.

EXAMPLES

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

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

       If you modified the schema to include a placeholder

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

       and ensuring you have is_virtual set to true:

	 __PACKAGE__->result_source_instance->is_virtual(1);

       You could now say:

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

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.

   deploy_depends_on
	 __PACKAGE__->result_source_instance->deploy_depends_on(
	     ["MyApp::Schema::Result::Year","MyApp::Schema::Result::CD"]
	     );

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

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.

OTHER METHODS

   new
       The constructor.

AUTHORS

       See "CONTRIBUTORS" in DBIx::Class.

LICENSE

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

perl v5.14.2							    2011-05-10				      DBIx::Class::ResultSource::View(3pm)