Removed backslash-escaping of single quotes where unnecessary, ran new
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer.pm
CommitLineData
16dc9970 1package SQL::Translator::Producer;
2
49e1eb70 3# -------------------------------------------------------------------
56435d6f 4# $Id: Producer.pm,v 1.6 2003-08-22 22:51:51 kycl4rk Exp $
49e1eb70 5# -------------------------------------------------------------------
abfa405a 6# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
7# darren chamberlain <darren@cpan.org>,
8# Chris Mungall <cjm@fruitfly.org>
077ebf34 9#
10# This program is free software; you can redistribute it and/or
11# modify it under the terms of the GNU General Public License as
12# published by the Free Software Foundation; version 2.
16dc9970 13#
077ebf34 14# This program is distributed in the hope that it will be useful, but
15# WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17# General Public License for more details.
16dc9970 18#
077ebf34 19# You should have received a copy of the GNU General Public License
20# along with this program; if not, write to the Free Software
21# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
22# 02111-1307 USA
23# -------------------------------------------------------------------
24
25use strict;
26use vars qw($VERSION);
56435d6f 27$VERSION = sprintf "%d.%02d", q$Revision: 1.6 $ =~ /(\d+)\.(\d+)/;
16dc9970 28
077ebf34 29sub produce { "" }
16dc9970 30
311;
32
49e1eb70 33# -------------------------------------------------------------------
16dc9970 34# A burnt child loves the fire.
35# Oscar Wilde
49e1eb70 36# -------------------------------------------------------------------
37
38=pod
16dc9970 39
40=head1 NAME
41
56435d6f 42SQL::Translator::Producer - describes how to write a producer
16dc9970 43
16dc9970 44=head1 DESCRIPTION
45
077ebf34 46Producer modules designed to be used with SQL::Translator need to
47implement a single function, called B<produce>. B<produce> will be
56435d6f 48called with the SQL::Translator object from which it is expected to
49retrieve the SQL::Translator::Schema object which has been populated
50by the parser. It is expected to return a string.
16dc9970 51
56435d6f 52=head1 AUTHORS
16dc9970 53
56435d6f 54Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
55Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
16dc9970 56
57=head1 SEE ALSO
58
56435d6f 59perl(1), SQL::Translator, SQL::Translator::Schema.
16dc9970 60
61=cut