Added an 'alter sequence' line to the parser grammer which will simply skip over...

[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer.pm

diff --git a/lib/SQL/Translator/Producer.pm b/lib/SQL/Translator/Producer.pm
index 22b7606..1b2baf2 100644 (file)
--- a/lib/SQL/Translator/Producer.pm
+++ b/lib/SQL/Translator/Producer.pm
@@ -1,10 +1,9 @@
 package SQL::Translator::Producer;
 
-#-----------------------------------------------------
-# $Id: Producer.pm,v 1.2 2002-03-21 18:50:53 dlc Exp $
-#-----------------------------------------------------
-# Copyright (C) 2002 Ken Y. Clark <kycl4rk@users.sourceforge.net>,
-#                    darren chamberlain <darren@cpan.org>
+# -------------------------------------------------------------------
+# $Id: Producer.pm,v 1.8 2006-06-07 16:28:59 schiffbruechige Exp $
+# -------------------------------------------------------------------
+# Copyright (C) 2002-4 SQLFairy Authors
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License as
@@ -23,38 +22,62 @@ package SQL::Translator::Producer;
 
 use strict;
 use vars qw($VERSION);
-$VERSION = sprintf "%d.%02d", q$Revision: 1.2 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
 
 sub produce { "" }
 
 1;
 
-#-----------------------------------------------------
+# -------------------------------------------------------------------
 # A burnt child loves the fire.
 # Oscar Wilde
-#-----------------------------------------------------
-
-=head1 NAME
+# -------------------------------------------------------------------
 
-SQL::Translator::Producer - base object for Producers
+=pod
 
-=head1 SYNOPSIS
+=head1 NAME
 
+SQL::Translator::Producer - describes how to write a producer
 
 =head1 DESCRIPTION
 
 Producer modules designed to be used with SQL::Translator need to
 implement a single function, called B<produce>.  B<produce> will be
-called with a data structure created by a SQL::Translator::Parser
-subclass.  It is expected to return a string containing a valid SQL
-create statement.
+called with the SQL::Translator object from which it is expected to 
+retrieve the SQL::Translator::Schema object which has been populated 
+by the parser.  It is expected to return a string.
+
+=head1 METHODS
+
+=over 4
+
+=item produce
+
+=item create_table($table)
+
+=item create_field($field)
+
+=item create_view($view)
+
+=item create_index($index)
+
+=item create_constraint($constraint)
+
+=item create_trigger($trigger)
+
+=item alter_field($from_field, $to_field)
+
+=item add_field($table, $new_field)
+
+=item drop_field($table, $old_field)
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Ken Y. Clark, kclark@logsoft.com
+Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 
 =head1 SEE ALSO
 
-perl(1).
+perl(1), SQL::Translator, SQL::Translator::Schema.
 
 =cut