.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SQL::Translator::Producer 3pm"
.TH SQL::Translator::Producer 3pm 2024-01-20 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SQL::Translator::Producer \- describes how to write a producer
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Producer modules designed to be used with SQL::Translator need to
implement a single function, called \fBproduce\fR.  \fBproduce\fR will be
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.
.SH METHODS
.IX Header "METHODS"
.IP produce 4
.IX Item "produce"
.PD 0
.IP create_table($table) 4
.IX Item "create_table($table)"
.IP create_field($field) 4
.IX Item "create_field($field)"
.IP create_view($view) 4
.IX Item "create_view($view)"
.IP create_index($index) 4
.IX Item "create_index($index)"
.IP create_constraint($constraint) 4
.IX Item "create_constraint($constraint)"
.IP create_trigger($trigger) 4
.IX Item "create_trigger($trigger)"
.ie n .IP "alter_field($from_field, $to_field)" 4
.el .IP "alter_field($from_field, \f(CW$to_field\fR)" 4
.IX Item "alter_field($from_field, $to_field)"
.ie n .IP "add_field($table, $new_field)" 4
.el .IP "add_field($table, \f(CW$new_field\fR)" 4
.IX Item "add_field($table, $new_field)"
.ie n .IP "drop_field($table, $old_field)" 4
.el .IP "drop_field($table, \f(CW$old_field\fR)" 4
.IX Item "drop_field($table, $old_field)"
.PD
.SH AUTHORS
.IX Header "AUTHORS"
Darren Chamberlain <darren@cpan.org>,
Ken Y. Clark <kclark@cpan.org>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1), SQL::Translator, SQL::Translator::Schema.