Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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)

Check Out this Related Man Page

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 => {
		 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.16.2							    2012-08-16				   SQL::Translator::Parser::DBIx::Class(3)
Man Page