sql::translator::parser::dbix::class(3pm) [debian 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)

DBIx::Class::Manual::DocMap(3)				User Contributed Perl Documentation			    DBIx::Class::Manual::DocMap(3)

NAME

       DBIx::Class::Manual::DocMap - What documentation do we have?

Manuals
       DBIx::Class::Manual - User's Manual overview.
       DBIx::Class::Manual::QuickStart - Up and running with DBIC in 10 minutes.
       DBIx::Class::Manual::Intro - More detailed introduction to setting up and using DBIx::Class.
       DBIx::Class::Manual::SQLHackers - How to use DBIx::Class if you know SQL (external, available on CPAN)
       DBIx::Class::Manual::Joining - Joining tables with DBIx::Class.
       DBIx::Class::Manual::Features - A boatload of DBIx::Class features with links to respective documentation.
       DBIx::Class::Manual::Glossary - What do all those terms mean?
       DBIx::Class::Manual::Cookbook - Various short recipes on how to do things.
       DBIx::Class::Manual::FAQ - Frequently Asked Questions, gathered from IRC and the mailing list.
       DBIx::Class::Manual::Troubleshooting - What to do if things go wrong (diagnostics of known error messages).

Some essential reference documentation
       The first two list items are the most important.

       "search" in DBIx::Class::ResultSet - Selecting and manipulating sets.
	   The DSL (mini-language) for query composition is only partially explained there, see "WHERE CLAUSES" in SQL::Abstract for the complete
	   details.

       $schema::Result::$resultclass - Classes representing a single result (row) from a DB query.
	   Such classes normally subclass DBIx::Class::Core, the methods inherited from DBIx::Class::Row and DBIx::Class::Relationship::Base are
	   used most often.

       DBIx::Class::ResultSetColumn - Perform operations on a single column of a ResultSet.
       DBIx::Class::ResultSource - Source/Table definition functions.
       DBIx::Class::Schema - Overall sources, and connection container.
       DBIx::Class::Relationship - Simple relationship declarations.
       DBIx::Class::Relationship::Base - Relationship declaration details.
       DBIx::Class::InflateColumn - Making objects out of your column values.

perl v5.18.2							    2014-01-05					    DBIx::Class::Manual::DocMap(3)