Improve trigger 'scope' attribute support (RT#119997)
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / YAML.pm
index 7c54273..c5055ff 100644 (file)
 package SQL::Translator::Producer::YAML;
 
-# -------------------------------------------------------------------
-# $Id: YAML.pm,v 1.3 2003-10-08 22:46:17 kycl4rk Exp $
-# -------------------------------------------------------------------
-# Copyright (C) 2003 darren chamberlain <darren@cpan.org>,
-#   Ken Y. Clark <kclark@cpan.org>.
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as
-# published by the Free Software Foundation; version 2.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-# 02111-1307  USA
-# -------------------------------------------------------------------
+=head1 NAME
+
+SQL::Translator::Producer::YAML - A YAML producer for SQL::Translator
+
+=head1 SYNOPSIS
+
+  use SQL::Translator;
+
+  my $translator = SQL::Translator->new(producer => 'YAML');
+
+=head1 DESCRIPTION
+
+This module uses YAML to serialize a schema to a string so that it
+can be saved to disk.  Serializing a schema and then calling producers
+on the stored can realize significant performance gains when parsing
+takes a long time.
+
+=cut
 
 use strict;
-use vars qw($VERSION);
-$VERSION = sprintf "%d.%02d", q$Revision: 1.3 $ =~ /(\d+)\.(\d+)/;
+use warnings;
+our $VERSION = '1.59';
 
 use YAML qw(Dump);
 
-# -------------------------------------------------------------------
 sub produce {
-    my $translator  = shift;
-    my $schema      = $translator->schema;
+    my $translator = shift;
+    my $schema     = $translator->schema;
 
     return Dump({
         schema => {
-            tables => { 
-                map { ($_->name => view_table($_)) } $schema->get_tables,
+            tables => {
+                map { ($_->name => view_table($_)) }
+                    $schema->get_tables,
             },
-            views => { 
-                map { ($_->name => view_view($_)) } $schema->get_views,
+            views => {
+                map { ($_->name => view_view($_)) }
+                    $schema->get_views,
             },
-            triggers => { 
-                map { ($_->name => view_trigger($_)) } $schema->get_triggers,
+            triggers => {
+                map { ($_->name => view_trigger($_)) }
+                    $schema->get_triggers,
             },
-            procedures => { 
-                map { ($_->name => view_procedure($_)) } 
-                $schema->get_procedures,
+            procedures => {
+                map { ($_->name => view_procedure($_)) }
+                    $schema->get_procedures,
             },
-        }
+        },
+        translator => {
+            add_drop_table => $translator->add_drop_table,
+            filename       => $translator->filename,
+            no_comments    => $translator->no_comments,
+            parser_args    => $translator->parser_args,
+            producer_args  => $translator->producer_args,
+            parser_type    => $translator->parser_type,
+            producer_type  => $translator->producer_type,
+            show_warnings  => $translator->show_warnings,
+            trace          => $translator->trace,
+            version        => $translator->version,
+        },
+        keys %{$schema->extra} ? ('extra' => { $schema->extra } ) : (),
     });
 }
 
-# -------------------------------------------------------------------
 sub view_table {
     my $table = shift;
-    my $name = $table->name;
 
     return {
-        'name'     => $table->name,
-        'order'    => $table->order,
-        'options'  => $table->options  || [],
-        'comments' => $table->comments || '',
-        'fields'   => { 
-            map { ($_->name => view_field($_)) } $table->get_fields 
+        'name'        => $table->name,
+        'order'       => $table->order,
+        'options'     => $table->options  || [],
+        $table->comments ? ('comments'    => [ $table->comments ] ) : (),
+        'constraints' => [
+            map { view_constraint($_) } $table->get_constraints
+        ],
+        'indices'     => [
+            map { view_index($_) } $table->get_indices
+        ],
+        'fields'      => {
+            map { ($_->name => view_field($_)) }
+                $table->get_fields
         },
+        keys %{$table->extra} ? ('extra' => { $table->extra } ) : (),
+    };
+}
+
+sub view_constraint {
+    my $constraint = shift;
+
+    return {
+        'deferrable'       => scalar $constraint->deferrable,
+        'expression'       => scalar $constraint->expression,
+        'fields'           => [ map { ref $_ ? $_->name : $_ } $constraint->field_names ],
+        'match_type'       => scalar $constraint->match_type,
+        'name'             => scalar $constraint->name,
+        'options'          => scalar $constraint->options,
+        'on_delete'        => scalar $constraint->on_delete,
+        'on_update'        => scalar $constraint->on_update,
+        'reference_fields' => [ map { ref $_ ? $_->name : $_ } $constraint->reference_fields ],
+        'reference_table'  => scalar $constraint->reference_table,
+        'type'             => scalar $constraint->type,
+        keys %{$constraint->extra} ? ('extra' => { $constraint->extra } ) : (),
     };
 }
 
-# -------------------------------------------------------------------
 sub view_field {
     my $field = shift;
 
     return {
-        'order' => scalar $field->order,
-        'name'  => scalar $field->name,
-        'type'  => scalar $field->data_type,
-        'size'  => [ $field->size ],
-        'extra' => { $field->extra },
+        'order'             => scalar $field->order,
+        'name'              => scalar $field->name,
+        'data_type'         => scalar $field->data_type,
+        'size'              => [ $field->size ],
+        'default_value'     => scalar $field->default_value,
+        'is_nullable'       => scalar $field->is_nullable,
+        'is_primary_key'    => scalar $field->is_primary_key,
+        'is_unique'         => scalar $field->is_unique,
+        $field->is_auto_increment ? ('is_auto_increment' => 1) : (),
+        $field->comments ? ('comments' => [ $field->comments ]) : (),
+        keys %{$field->extra} ? ('extra' => { $field->extra } ) : (),
     };
 }
 
-# -------------------------------------------------------------------
 sub view_procedure {
     my $procedure = shift;
 
@@ -91,10 +133,10 @@ sub view_procedure {
         'parameters' => scalar $procedure->parameters,
         'owner'      => scalar $procedure->owner,
         'comments'   => scalar $procedure->comments,
+        keys %{$procedure->extra} ? ('extra' => { $procedure->extra } ) : (),
     };
 }
 
-# -------------------------------------------------------------------
 sub view_trigger {
     my $trigger = shift;
 
@@ -102,14 +144,15 @@ sub view_trigger {
         'order'               => scalar $trigger->order,
         'name'                => scalar $trigger->name,
         'perform_action_when' => scalar $trigger->perform_action_when,
-        'database_event'      => scalar $trigger->database_event,
+        'database_events'     => scalar $trigger->database_events,
         'fields'              => scalar $trigger->fields,
         'on_table'            => scalar $trigger->on_table,
         'action'              => scalar $trigger->action,
+        'scope'               => scalar $trigger->scope,
+        keys %{$trigger->extra} ? ('extra' => { $trigger->extra } ) : (),
     };
 }
 
-# -------------------------------------------------------------------
 sub view_view {
     my $view = shift;
 
@@ -118,18 +161,31 @@ sub view_view {
         'name'   => scalar $view->name,
         'sql'    => scalar $view->sql,
         'fields' => scalar $view->fields,
+        keys %{$view->extra} ? ('extra' => { $view->extra } ) : (),
+    };
+}
+
+sub view_index {
+    my $index = shift;
+
+    return {
+        'name'      => scalar $index->name,
+        'type'      => scalar $index->type,
+        'fields'    => scalar $index->fields,
+        'options'   => scalar $index->options,
+        keys %{$index->extra} ? ('extra' => { $index->extra } ) : (),
     };
 }
 
 1;
 
-=head1 NAME
+=head1 SEE ALSO
 
-SQL::Translator::Producer::YAML - A YAML producer for SQL::Translator
+SQL::Translator, YAML, http://www.yaml.org/.
 
 =head1 AUTHORS
 
 darren chamberlain E<lt>darren@cpan.orgE<gt>,
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
 
 =cut