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

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

NAME

       DBIx::Class::Schema::Loader::RelBuilder - Builds relationships for DBIx::Class::Schema::Loader

SYNOPSIS

       See DBIx::Class::Schema::Loader and DBIx::Class::Schema::Loader::Base.

DESCRIPTION

       This class builds relationships for DBIx::Class::Schema::Loader.  This is module is not (yet) for external use.

METHODS

   new
       Arguments: $loader object

   generate_code
       Arguments:

	   [
	       [ local_moniker1 (scalar), fk_info1 (arrayref), uniq_info1 (arrayref) ]
	       [ local_moniker2 (scalar), fk_info2 (arrayref), uniq_info2 (arrayref) ]
	       ...
	   ]

       This generates the code for the relationships of each table.

       "local_moniker" is the moniker name of the table which had the REFERENCES statements.  The fk_info arrayref's contents should take the
       form:

	   [
	       {
		   local_table	  => 'some_table',
		   local_moniker  => 'SomeTable',
		   local_columns  => [ 'col2', 'col3' ],
		   remote_table   => 'another_table_moniker',
		   remote_moniker => 'AnotherTableMoniker',
		   remote_columns => [ 'col5', 'col7' ],
	       },
	       {
		   local_table	  => 'some_other_table',
		   local_moniker  => 'SomeOtherTable',
		   local_columns  => [ 'col1', 'col4' ],
		   remote_table   => 'yet_another_table_moniker',
		   remote_moniker => 'YetAnotherTableMoniker',
		   remote_columns => [ 'col1', 'col2' ],
	       },
	       # ...
	   ],

       The uniq_info arrayref's contents should take the form:

	   [
	       [
		   uniq_constraint_name 	=> [ 'col1', 'col2' ],
	       ],
	       [
		   another_uniq_constraint_name => [ 'col1', 'col2' ],
	       ],
	   ],

       This method will return the generated relationships as a hashref keyed on the class names.  The values are arrayrefs of hashes containing
       method name and arguments, like so:

	 {
	     'Some::Source::Class' => [
		 { method => 'belongs_to', arguments => [ 'col1', 'Another::Source::Class' ],
		 { method => 'has_many', arguments => [ 'anothers', 'Yet::Another::Source::Class', 'col15' ],
	     ],
	     'Another::Source::Class' => [
		 # ...
	     ],
	     # ...
	 }

AUTHOR

       See "AUTHOR" in DBIx::Class::Schema::Loader and "CONTRIBUTORS" in DBIx::Class::Schema::Loader.

LICENSE

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

perl v5.14.2							    2012-06-08			      DBIx::Class::Schema::Loader::RelBuilder(3pm)

Check Out this Related Man Page

SQL::Translator::Parser::DBIx::Class(3pm)		User Contributed Perl Documentation		 SQL::Translator::Parser::DBIx::Class(3pm)

NAME

       SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema from a DBIx::Class::Schema instance

SYNOPSIS

	## Via DBIx::Class
	use MyApp::Schema;
	my $schema = MyApp::Schema->connect("dbi:SQLite:something.db");
	$schema->create_ddl_dir();
	## or
	$schema->deploy();

	## Standalone
	use MyApp::Schema;
	use SQL::Translator;

	my $schema = MyApp::Schema->connect;
	my $trans  = SQL::Translator->new (
	     parser	 => 'SQL::Translator::Parser::DBIx::Class',
	     parser_args => {
		 package => $schema,
		 add_fk_index => 0,
		 sources => [qw/
		   Artist
		   CD
		 /],
	     },
	     producer	 => 'SQLite',
	    ) or die SQL::Translator->error;
	my $out = $trans->translate() or die $trans->error;

DESCRIPTION

       This class requires SQL::Translator installed to work.

       "SQL::Translator::Parser::DBIx::Class" reads a DBIx::Class schema, interrogates the columns, and stuffs it all in an $sqlt_schema object.

       Its primary use is in deploying database layouts described as a set of DBIx::Class classes, to a database. To do this, see "deploy" in
       DBIx::Class::Schema.

       This can also be achieved by having DBIx::Class export the schema as a set of SQL files ready for import into your database, or passed to
       other machines that need to have your application installed but don't have SQL::Translator installed. To do this see "create_ddl_dir" in
       DBIx::Class::Schema.

PARSER OPTIONS

   add_fk_index
       Create an index for each foreign key.  Enabled by default, as having indexed foreign key columns is normally the sensible thing to do.

   sources
       Arguments: @class_names

       Limit the amount of parsed sources by supplying an explicit list of source names.

SEE ALSO

       SQL::Translator, DBIx::Class::Schema

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				 SQL::Translator::Parser::DBIx::Class(3pm)

Linux and UNIX Man Pages

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

Check Out this Related Man Page