Downgrade global version - highest version in 9002 on cpan is 1.58 - thus go with...
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / YAML.pm
index 408f361..98bdd90 100644 (file)
@@ -1,10 +1,7 @@
 package SQL::Translator::Producer::YAML;
 
 # -------------------------------------------------------------------
-# $Id: YAML.pm,v 1.4 2003-10-09 21:51:08 kycl4rk Exp $
-# -------------------------------------------------------------------
-# Copyright (C) 2003 darren chamberlain <darren@cpan.org>,
-#   Ken Y. Clark <kclark@cpan.org>.
+# Copyright (C) 2002-2009 SQLFairy Authors
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License as
@@ -21,32 +18,66 @@ package SQL::Translator::Producer::YAML;
 # 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.4 $ =~ /(\d+)\.(\d+)/;
+$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,
+                map { ($_->name => view_table($_)) }
+                    $schema->get_tables,
             },
             views => { 
-                map { ($_->name => view_view($_)) } $schema->get_views,
+                map { ($_->name => view_view($_)) }
+                    $schema->get_views,
             },
             triggers => { 
-                map { ($_->name => view_trigger($_)) } $schema->get_triggers,
+                map { ($_->name => view_trigger($_)) }
+                    $schema->get_triggers,
             },
             procedures => { 
                 map { ($_->name => view_procedure($_)) } 
-                $schema->get_procedures,
+                    $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,
         }
     });
 }
@@ -54,33 +85,60 @@ sub produce {
 # -------------------------------------------------------------------
 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 
         },
     };
 }
 
 # -------------------------------------------------------------------
+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' => scalar $constraint->reference_fields,
+        'reference_table'  => scalar $constraint->reference_table,
+        'type'             => scalar $constraint->type,
+    };
+}
+
+# -------------------------------------------------------------------
 sub view_field {
     my $field = shift;
 
     return {
-        '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,
-        '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) : (),
+        'extra'             => { $field->extra },
     };
 }
 
@@ -125,11 +183,25 @@ sub view_view {
     };
 }
 
+# -------------------------------------------------------------------
+sub view_index {
+    my $index = shift;
+
+    return {
+        'name'      => scalar $index->name,
+        'type'      => scalar $index->type,
+        'fields'    => scalar $index->fields,
+        'options'   => scalar $index->options,
+    };
+}
+
 1;
 
-=head1 NAME
+# -------------------------------------------------------------------
 
-SQL::Translator::Producer::YAML - A YAML producer for SQL::Translator
+=head1 SEE ALSO
+
+SQL::Translator, YAML, http://www.yaml.org/.
 
 =head1 AUTHORS