catalyst::traitfor::model::dbic::schema::schemaproxy(3pm) [debian man page]

Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy(3pmUser Contributed Perl DocumentatiCatalyst::TraitFor::Model::DBIC::Schema::SchemaProxy(3pm)

NAME

       Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy - Proxy Schema Methods and Options from Model

DESCRIPTION

       Allows you to call your DBIx::Class::Schema methods directly on the Model instance, and passes config options to your DBIx::Class::Schema
       and DBIx::Class::ResultSet attributes at "BUILD" time.

       Methods and attributes local to your "Model" take precedence over DBIx::Class::Schema or DBIx::Class::ResultSet methods and attributes.

CREATING SCHEMA CONFIG ATTRIBUTES

       To create attributes in your "Schema.pm", use either Moose or Class::Accessor::Grouped, which is inherited from by all DBIx::Class classes
       automatically. E.g.:

	   __PACKAGE__->mk_group_accessors(simple => qw/
	       config_key1
	       config_key2
	       ...
	   /);

       Or with Moose:

	   use Moose;
	   has config_key1 => (is => 'rw', default => 'default_value');

       This code can be added after the md5sum on DBIx::Class::Schema::Loader generated schemas.

       At app startup, any non-local options will be passed to these accessors, and can be accessed as usual via "$schema->config_key1".

       These config values go into your "Model::DB" block, along with normal config values.

CREATING RESULTSET CONFIG ATTRIBUTES

       You can create classdata on DBIx::Class::ResultSet classes to hold values from Catalyst config.

       The code for this looks something like this:

	   package MySchema::ResultSet::Foo;

	   use base 'DBIx::Class::ResultSet';

	   __PACKAGE__->mk_group_accessors(inherited => qw/
	       rs_config_key1
	       rs_config_key2
	       ...
	   /);
	   __PACKAGE__->rs_config_key1('default_value');

       Or, if you prefer Moose:

	   package MySchema::ResultSet::Foo;

	   use Moose;
	   use MooseX::NonMoose;
	   use MooseX::ClassAttribute;
	   extends 'DBIx::Class::ResultSet';

	   sub BUILDARGS { $_[2] } # important

	   class_has rs_config_key1 => (is => 'rw', default => 'default_value');

	   ...

	   __PACKAGE__->meta->make_immutable;

	   1;

       In your catalyst config, use the generated Model name as the config key, e.g.:

	   <Model::DB::Users>
	       strict_passwords 1
	   </Model::DB::Users>

SEE ALSO

       Catalyst::Model::DBIC::Schema, DBIx::Class::Schema

AUTHOR

       See "AUTHOR" in Catalyst::Model::DBIC::Schema and "CONTRIBUTORS" in Catalyst::Model::DBIC::Schema.

COPYRIGHT

       See "COPYRIGHT" in Catalyst::Model::DBIC::Schema.

LICENSE

       This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2012-06-12		 Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy(3pm)

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)