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::Schema::Procedure(3pm) 		User Contributed Perl Documentation		   SQL::Translator::Schema::Procedure(3pm)

NAME

       SQL::Translator::Schema::Procedure - SQL::Translator procedure object

SYNOPSIS

	 use SQL::Translator::Schema::Procedure;
	 my $procedure	= SQL::Translator::Schema::Procedure->new(
	     name	=> 'foo',
	     sql	=> 'CREATE PROC foo AS SELECT * FROM bar',
	     parameters => 'foo,bar',
	     owner	=> 'nomar',
	     comments	=> 'blah blah blah',
	     schema	=> $schema,
	 );

DESCRIPTION

       "SQL::Translator::Schema::Procedure" is a class for dealing with stored procedures (and possibly other pieces of nameable SQL code?).

METHODS

   new
       Object constructor.

	 my $schema = SQL::Translator::Schema::Procedure->new;

   parameters
       Gets and set the parameters of the stored procedure.

	 $procedure->parameters('id');
	 $procedure->parameters('id', 'name');
	 $procedure->parameters( 'id, name' );
	 $procedure->parameters( [ 'id', 'name' ] );
	 $procedure->parameters( qw[ id name ] );

	 my @parameters = $procedure->parameters;

   name
       Get or set the procedure's name.

	 $procedure->name('foo');
	 my $name = $procedure->name;

   sql
       Get or set the procedure's SQL.

	 $procedure->sql('select * from foo');
	 my $sql = $procedure->sql;

   order
       Get or set the order of the procedure.

	 $procedure->order( 3 );
	 my $order = $procedure->order;

   owner
       Get or set the owner of the procedure.

	 $procedure->owner('nomar');
	 my $sql = $procedure->owner;

   comments
       Get or set the comments on a procedure.

	 $procedure->comments('foo');
	 $procedure->comments('bar');
	 print join( ', ', $procedure->comments ); # prints "foo, bar"

   schema
       Get or set the procedures's schema object.

	 $procedure->schema( $schema );
	 my $schema = $procedure->schema;

   equals
       Determines if this procedure is the same as another

	 my $isIdentical = $procedure1->equals( $procedure2 );

AUTHORS

       Ken Youens-Clark <kclark@cshl.org>, Paul Harrington <Paul-Harrington@deshaw.com>.

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