lib/SQL/Translator/Producer/YAML.pm

   1 package SQL::Translator::Producer::YAML;
   2
   3 # -------------------------------------------------------------------
   4 # $Id: YAML.pm,v 1.7 2004-01-25 18:13:46 kycl4rk Exp $
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2003 darren chamberlain <darren@cpan.org>,
   7 #   Ken Y. Clark <kclark@cpan.org>.
   8 #
   9 # This program is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU General Public License as
  11 # published by the Free Software Foundation; version 2.
  12 #
  13 # This program is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 # General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  21 # 02111-1307  USA
  22 # -------------------------------------------------------------------
  23
  24 =head1 NAME
  25
  26 SQL::Translator::Producer::YAML - A YAML producer for SQL::Translator
  27
  28 =head1 SYNOPSIS
  29
  30   use SQL::Translator;
  31
  32   my $translator = SQL::Translator->new(producer => 'YAML');
  33
  34 =head1 DESCRIPTION
  35
  36 This module uses YAML to serialize a schema to a string so that it
  37 can be saved to disk.  Serializing a schema and then calling producers
  38 on the stored can realize significant performance gains when parsing
  39 takes a long time.
  40
  41 =cut
  42
  43 use strict;
  44 use vars qw($VERSION);
  45 $VERSION = sprintf "%d.%02d", q$Revision: 1.7 $ =~ /(\d+)\.(\d+)/;
  46
  47 use YAML qw(Dump);
  48
  49 # -------------------------------------------------------------------
  50 sub produce {
  51     my $translator  = shift;
  52     my $schema      = $translator->schema;
  53
  54     return Dump({
  55         schema => {
  56             tables => {
  57                 map { ($_->name => view_table($_)) }
  58                     $schema->get_tables,
  59             },
  60             views => {
  61                 map { ($_->name => view_view($_)) }
  62                     $schema->get_views,
  63             },
  64             triggers => {
  65                 map { ($_->name => view_trigger($_)) }
  66                     $schema->get_triggers,
  67             },
  68             procedures => {
  69                 map { ($_->name => view_procedure($_)) }
  70                     $schema->get_procedures,
  71             },
  72         }
  73     });
  74 }
  75
  76 # -------------------------------------------------------------------
  77 sub view_table {
  78     my $table = shift;
  79
  80     return {
  81         'name'        => $table->name,
  82         'order'       => $table->order,
  83         'options'     => $table->options  || [],
  84         'comments'    => $table->comments || '',
  85         'constraints' => [
  86             map { view_constraint($_) } $table->get_constraints
  87         ],
  88         'indices'     => [
  89             map { view_index($_) } $table->get_indices
  90         ],
  91         'fields'      => {
  92             map { ($_->name => view_field($_)) }
  93                 $table->get_fields
  94         },
  95     };
  96 }
  97
  98 # -------------------------------------------------------------------
  99 sub view_constraint {
 100     my $constraint = shift;
 101
 102     return {
 103         'deferrable'       => scalar $constraint->deferrable,
 104         'expression'       => scalar $constraint->expression,
 105         'fields'           => scalar $constraint->fields,
 106         'match_type'       => scalar $constraint->match_type,
 107         'name'             => scalar $constraint->name,
 108         'options'          => scalar $constraint->options,
 109         'on_delete'        => scalar $constraint->on_delete,
 110         'on_update'        => scalar $constraint->on_update,
 111         'reference_fields' => scalar $constraint->reference_fields,
 112         'reference_table'  => scalar $constraint->reference_table,
 113         'type'             => scalar $constraint->type,
 114     };
 115 }
 116
 117 # -------------------------------------------------------------------
 118 sub view_field {
 119     my $field = shift;
 120
 121     return {
 122         'order'          => scalar $field->order,
 123         'name'           => scalar $field->name,
 124         'data_type'      => scalar $field->data_type,
 125         'size'           => [ $field->size ],
 126         'default_value'  => scalar $field->default_value,
 127         'is_nullable'    => scalar $field->is_nullable,
 128         'is_primary_key' => scalar $field->is_primary_key,
 129         'is_unique'      => scalar $field->is_unique,
 130         'extra'          => { $field->extra },
 131     };
 132 }
 133
 134 # -------------------------------------------------------------------
 135 sub view_procedure {
 136     my $procedure = shift;
 137
 138     return {
 139         'order'      => scalar $procedure->order,
 140         'name'       => scalar $procedure->name,
 141         'sql'        => scalar $procedure->sql,
 142         'parameters' => scalar $procedure->parameters,
 143         'owner'      => scalar $procedure->owner,
 144         'comments'   => scalar $procedure->comments,
 145     };
 146 }
 147
 148 # -------------------------------------------------------------------
 149 sub view_trigger {
 150     my $trigger = shift;
 151
 152     return {
 153         'order'               => scalar $trigger->order,
 154         'name'                => scalar $trigger->name,
 155         'perform_action_when' => scalar $trigger->perform_action_when,
 156         'database_event'      => scalar $trigger->database_event,
 157         'fields'              => scalar $trigger->fields,
 158         'on_table'            => scalar $trigger->on_table,
 159         'action'              => scalar $trigger->action,
 160     };
 161 }
 162
 163 # -------------------------------------------------------------------
 164 sub view_view {
 165     my $view = shift;
 166
 167     return {
 168         'order'  => scalar $view->order,
 169         'name'   => scalar $view->name,
 170         'sql'    => scalar $view->sql,
 171         'fields' => scalar $view->fields,
 172     };
 173 }
 174
 175 # -------------------------------------------------------------------
 176 sub view_index {
 177     my $index = shift;
 178
 179     return {
 180         'name'      => scalar $index->name,
 181         'type'      => scalar $index->type,
 182         'fields'    => scalar $index->fields,
 183         'options'   => scalar $index->options,
 184     };
 185 }
 186
 187 1;
 188
 189 # -------------------------------------------------------------------
 190
 191 =head1 SEE ALSO
 192
 193 SQL::Translator, YAML, http://www.yaml.org/.
 194
 195 =head1 AUTHORS
 196
 197 darren chamberlain E<lt>darren@cpan.orgE<gt>,
 198 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 199
 200 =cut