lib/SQL/Translator/Producer.pm

   1 package SQL::Translator::Producer;
   2
   3 # -------------------------------------------------------------------
   4 # $Id: Producer.pm,v 1.8 2006-06-07 16:28:59 schiffbruechige Exp $
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2002-4 SQLFairy Authors
   7 #
   8 # This program is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU General Public License as
  10 # published by the Free Software Foundation; version 2.
  11 #
  12 # This program is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  20 # 02111-1307  USA
  21 # -------------------------------------------------------------------
  22
  23 use strict;
  24 use vars qw($VERSION);
  25 $VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
  26
  27 sub produce { "" }
  28
  29 # Do not rely on this if you are not bundled with SQL::Translator.
  30 # -- rjbs, 2008-09-30
  31 ## $exceptions contains an arrayref of paired values
  32 ## Each pair contains a pattern match or string, and a value to be used as
  33 ## the default if matched.
  34 ## They are special per Producer, and provide support for the old 'now()'
  35 ## default value exceptions
  36 sub _apply_default_value {
  37   my (undef, $field_ref, $default, $exceptions, $noquote) = @_;
  38
  39   my @noquote = (defined $noquote)?@$noquote:();
  40
  41   if ($exceptions and ! ref $default) {
  42     for (my $i = 0; $i < @$exceptions; $i += 2) {
  43       my ($pat, $val) = @$exceptions[ $i, $i + 1 ];
  44       if (ref $pat and $default =~ $pat) {
  45           $default = $val;
  46           last;
  47       } elsif (lc $default eq lc $pat) {
  48           $default = $val;
  49           last
  50       }
  51     }
  52   }
  53
  54   my $qc = (grep m/$default/, @noquote)?"":"'";
  55   if (ref $default) {
  56       $$field_ref .= " DEFAULT $$default";
  57   } else {
  58       $$field_ref .= " DEFAULT $qc$default$qc";
  59   }
  60
  61 }
  62
  63 1;
  64
  65 # -------------------------------------------------------------------
  66 # A burnt child loves the fire.
  67 # Oscar Wilde
  68 # -------------------------------------------------------------------
  69
  70 =pod
  71
  72 =head1 NAME
  73
  74 SQL::Translator::Producer - describes how to write a producer
  75
  76 =head1 DESCRIPTION
  77
  78 Producer modules designed to be used with SQL::Translator need to
  79 implement a single function, called B<produce>.  B<produce> will be
  80 called with the SQL::Translator object from which it is expected to
  81 retrieve the SQL::Translator::Schema object which has been populated
  82 by the parser.  It is expected to return a string.
  83
  84 =head1 METHODS
  85
  86 =over 4
  87
  88 =item produce
  89
  90 =item create_table($table)
  91
  92 =item create_field($field)
  93
  94 =item create_view($view)
  95
  96 =item create_index($index)
  97
  98 =item create_constraint($constraint)
  99
 100 =item create_trigger($trigger)
 101
 102 =item alter_field($from_field, $to_field)
 103
 104 =item add_field($table, $new_field)
 105
 106 =item drop_field($table, $old_field)
 107
 108 =head1 AUTHORS
 109
 110 Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
 111 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 112
 113 =head1 SEE ALSO
 114
 115 perl(1), SQL::Translator, SQL::Translator::Schema.
 116
 117 =cut