sql::translator::parser(3pm) [debian man page]

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

NAME

       SQL::Translator::Parser - describes how to write a parser

DESCRIPTION

       Parser modules that get invoked by SQL::Translator need to implement a single function: parse.  This function will be called by the
       SQL::Translator instance as $class::parse($tr, $data_as_string), where $tr is a SQL::Translator instance.  Other than that, the classes are
       free to define any helper functions, or use any design pattern internally that make the most sense.

       When the parser has determined what exists, it will communicate the structure to the producer through the SQL::Translator::Schema object.
       This object can be retrieved from the translator (the first argument pass to parse) by calling the schema method:

	 my $schema = $tr->schema;

       The Schema object has methods for adding tables, fields, indices, etc.  For more information, consult the docs for SQL::Translator::Schema
       and its related modules.  For examples of how this works, examine the source code for existing SQL::Translator::Parser::* modules.

AUTHORS

       Ken Youens-Clark, <kclark@cpan.org<gt>, darren chamberlain <darren@cpan.org>.

SEE ALSO

       perl(1), SQL::Translator, SQL::Translator::Schema.

perl v5.14.2							    2012-01-18					      SQL::Translator::Parser(3pm)

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

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 => {
		 dbic_schema => $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

   dbic_schema
       The DBIx::Class schema (either an instance or a class name) to be parsed.  This argument is in fact optional - instead one can supply it
       later at translation time as an argument to "translate" in SQL::Translator. In other words both of the following invocations are valid and
       will produce conceptually identical output:

	 my $yaml = SQL::Translator->new(
	   parser => 'SQL::Translator::Parser::DBIx::Class',
	   parser_args => {
	     dbic_schema => $schema,
	   },
	   producer => 'SQL::Translator::Producer::YAML',
	 )->translate;

	 my $yaml = SQL::Translator->new(
	   parser => 'SQL::Translator::Parser::DBIx::Class',
	   producer => 'SQL::Translator::Producer::YAML',
	 )->translate(data => $schema);

   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.18.2							    2014-01-22				   SQL::Translator::Parser::DBIx::Class(3)