1 package SQL::Translator::Producer::YAML;
3 # -------------------------------------------------------------------
4 # Copyright (C) 2002-2009 SQLFairy Authors
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; version 2.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 # -------------------------------------------------------------------
23 SQL::Translator::Producer::YAML - A YAML producer for SQL::Translator
29 my $translator = SQL::Translator->new(producer => 'YAML');
33 This module uses YAML to serialize a schema to a string so that it
34 can be saved to disk. Serializing a schema and then calling producers
35 on the stored can realize significant performance gains when parsing
41 use vars qw($VERSION);
46 # -------------------------------------------------------------------
48 my $translator = shift;
49 my $schema = $translator->schema;
54 map { ($_->name => view_table($_)) }
58 map { ($_->name => view_view($_)) }
62 map { ($_->name => view_trigger($_)) }
63 $schema->get_triggers,
66 map { ($_->name => view_procedure($_)) }
67 $schema->get_procedures,
71 add_drop_table => $translator->add_drop_table,
72 filename => $translator->filename,
73 no_comments => $translator->no_comments,
74 parser_args => $translator->parser_args,
75 producer_args => $translator->producer_args,
76 parser_type => $translator->parser_type,
77 producer_type => $translator->producer_type,
78 show_warnings => $translator->show_warnings,
79 trace => $translator->trace,
80 version => $translator->version,
85 # -------------------------------------------------------------------
90 'name' => $table->name,
91 'order' => $table->order,
92 'options' => $table->options || [],
93 $table->comments ? ('comments' => $table->comments ) : (),
95 map { view_constraint($_) } $table->get_constraints
98 map { view_index($_) } $table->get_indices
101 map { ($_->name => view_field($_)) }
107 # -------------------------------------------------------------------
108 sub view_constraint {
109 my $constraint = shift;
112 'deferrable' => scalar $constraint->deferrable,
113 'expression' => scalar $constraint->expression,
114 'fields' => [ map { ref $_ ? $_->name : $_ } $constraint->field_names ],
115 'match_type' => scalar $constraint->match_type,
116 'name' => scalar $constraint->name,
117 'options' => scalar $constraint->options,
118 'on_delete' => scalar $constraint->on_delete,
119 'on_update' => scalar $constraint->on_update,
120 'reference_fields' => scalar $constraint->reference_fields,
121 'reference_table' => scalar $constraint->reference_table,
122 'type' => scalar $constraint->type,
126 # -------------------------------------------------------------------
131 'order' => scalar $field->order,
132 'name' => scalar $field->name,
133 'data_type' => scalar $field->data_type,
134 'size' => [ $field->size ],
135 'default_value' => scalar $field->default_value,
136 'is_nullable' => scalar $field->is_nullable,
137 'is_primary_key' => scalar $field->is_primary_key,
138 'is_unique' => scalar $field->is_unique,
139 $field->is_auto_increment ? ('is_auto_increment' => 1) : (),
140 $field->comments ? ('comments' => $field->comments) : (),
141 'extra' => { $field->extra },
145 # -------------------------------------------------------------------
147 my $procedure = shift;
150 'order' => scalar $procedure->order,
151 'name' => scalar $procedure->name,
152 'sql' => scalar $procedure->sql,
153 'parameters' => scalar $procedure->parameters,
154 'owner' => scalar $procedure->owner,
155 'comments' => scalar $procedure->comments,
159 # -------------------------------------------------------------------
164 'order' => scalar $trigger->order,
165 'name' => scalar $trigger->name,
166 'perform_action_when' => scalar $trigger->perform_action_when,
167 'database_event' => scalar $trigger->database_event,
168 'fields' => scalar $trigger->fields,
169 'on_table' => scalar $trigger->on_table,
170 'action' => scalar $trigger->action,
174 # -------------------------------------------------------------------
179 'order' => scalar $view->order,
180 'name' => scalar $view->name,
181 'sql' => scalar $view->sql,
182 'fields' => scalar $view->fields,
186 # -------------------------------------------------------------------
191 'name' => scalar $index->name,
192 'type' => scalar $index->type,
193 'fields' => scalar $index->fields,
194 'options' => scalar $index->options,
200 # -------------------------------------------------------------------
204 SQL::Translator, YAML, http://www.yaml.org/.
208 darren chamberlain E<lt>darren@cpan.orgE<gt>,
209 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.