Commit | Line | Data |
d3fad399 |
1 | package SQL::Translator::Producer::YAML; |
2 | |
75c75c55 |
3 | =head1 NAME |
4 | |
5 | SQL::Translator::Producer::YAML - A YAML producer for SQL::Translator |
6 | |
7 | =head1 SYNOPSIS |
8 | |
9 | use SQL::Translator; |
10 | |
c16f976a |
11 | my $translator = SQL::Translator->new(producer => 'YAML'); |
75c75c55 |
12 | |
13 | =head1 DESCRIPTION |
14 | |
15 | This module uses YAML to serialize a schema to a string so that it |
16 | can be saved to disk. Serializing a schema and then calling producers |
17 | on the stored can realize significant performance gains when parsing |
18 | takes a long time. |
19 | |
20 | =cut |
21 | |
d3fad399 |
22 | use strict; |
f27f9229 |
23 | use warnings; |
da93ce68 |
24 | our $VERSION = '1.60'; |
d3fad399 |
25 | |
af53e4ec |
26 | use YAML qw(Dump); |
d3fad399 |
27 | |
28 | sub produce { |
07f25b8d |
29 | my $translator = shift; |
30 | my $schema = $translator->schema; |
d3fad399 |
31 | |
af53e4ec |
32 | return Dump({ |
33 | schema => { |
ea93df61 |
34 | tables => { |
c16f976a |
35 | map { ($_->name => view_table($_)) } |
36 | $schema->get_tables, |
6785b14e |
37 | }, |
ea93df61 |
38 | views => { |
c16f976a |
39 | map { ($_->name => view_view($_)) } |
40 | $schema->get_views, |
6785b14e |
41 | }, |
ea93df61 |
42 | triggers => { |
c16f976a |
43 | map { ($_->name => view_trigger($_)) } |
44 | $schema->get_triggers, |
6785b14e |
45 | }, |
ea93df61 |
46 | procedures => { |
47 | map { ($_->name => view_procedure($_)) } |
c16f976a |
48 | $schema->get_procedures, |
6785b14e |
49 | }, |
25a2e5c6 |
50 | }, |
51 | translator => { |
52 | add_drop_table => $translator->add_drop_table, |
53 | filename => $translator->filename, |
54 | no_comments => $translator->no_comments, |
55 | parser_args => $translator->parser_args, |
56 | producer_args => $translator->producer_args, |
57 | parser_type => $translator->parser_type, |
58 | producer_type => $translator->producer_type, |
59 | show_warnings => $translator->show_warnings, |
60 | trace => $translator->trace, |
61 | version => $translator->version, |
00db1ad5 |
62 | }, |
63 | keys %{$schema->extra} ? ('extra' => { $schema->extra } ) : (), |
af53e4ec |
64 | }); |
d3fad399 |
65 | } |
66 | |
67 | sub view_table { |
68 | my $table = shift; |
69 | |
af53e4ec |
70 | return { |
b3d280e2 |
71 | 'name' => $table->name, |
72 | 'order' => $table->order, |
73 | 'options' => $table->options || [], |
99fa843e |
74 | $table->comments ? ('comments' => [ $table->comments ] ) : (), |
b3d280e2 |
75 | 'constraints' => [ |
76 | map { view_constraint($_) } $table->get_constraints |
77 | ], |
78 | 'indices' => [ |
79 | map { view_index($_) } $table->get_indices |
80 | ], |
ea93df61 |
81 | 'fields' => { |
c16f976a |
82 | map { ($_->name => view_field($_)) } |
ea93df61 |
83 | $table->get_fields |
6785b14e |
84 | }, |
00db1ad5 |
85 | keys %{$table->extra} ? ('extra' => { $table->extra } ) : (), |
af53e4ec |
86 | }; |
d3fad399 |
87 | } |
88 | |
b3d280e2 |
89 | sub view_constraint { |
90 | my $constraint = shift; |
91 | |
92 | return { |
93 | 'deferrable' => scalar $constraint->deferrable, |
94 | 'expression' => scalar $constraint->expression, |
4d438549 |
95 | 'fields' => [ map { ref $_ ? $_->name : $_ } $constraint->field_names ], |
b3d280e2 |
96 | 'match_type' => scalar $constraint->match_type, |
97 | 'name' => scalar $constraint->name, |
98 | 'options' => scalar $constraint->options, |
99 | 'on_delete' => scalar $constraint->on_delete, |
100 | 'on_update' => scalar $constraint->on_update, |
00db1ad5 |
101 | 'reference_fields' => [ map { ref $_ ? $_->name : $_ } $constraint->reference_fields ], |
b3d280e2 |
102 | 'reference_table' => scalar $constraint->reference_table, |
103 | 'type' => scalar $constraint->type, |
00db1ad5 |
104 | keys %{$constraint->extra} ? ('extra' => { $constraint->extra } ) : (), |
b3d280e2 |
105 | }; |
106 | } |
107 | |
d3fad399 |
108 | sub view_field { |
109 | my $field = shift; |
110 | |
af53e4ec |
111 | return { |
4d438549 |
112 | 'order' => scalar $field->order, |
113 | 'name' => scalar $field->name, |
114 | 'data_type' => scalar $field->data_type, |
115 | 'size' => [ $field->size ], |
116 | 'default_value' => scalar $field->default_value, |
117 | 'is_nullable' => scalar $field->is_nullable, |
118 | 'is_primary_key' => scalar $field->is_primary_key, |
119 | 'is_unique' => scalar $field->is_unique, |
120 | $field->is_auto_increment ? ('is_auto_increment' => 1) : (), |
99fa843e |
121 | $field->comments ? ('comments' => [ $field->comments ]) : (), |
00db1ad5 |
122 | keys %{$field->extra} ? ('extra' => { $field->extra } ) : (), |
af53e4ec |
123 | }; |
d3fad399 |
124 | } |
125 | |
6785b14e |
126 | sub view_procedure { |
127 | my $procedure = shift; |
128 | |
129 | return { |
130 | 'order' => scalar $procedure->order, |
131 | 'name' => scalar $procedure->name, |
132 | 'sql' => scalar $procedure->sql, |
133 | 'parameters' => scalar $procedure->parameters, |
134 | 'owner' => scalar $procedure->owner, |
135 | 'comments' => scalar $procedure->comments, |
00db1ad5 |
136 | keys %{$procedure->extra} ? ('extra' => { $procedure->extra } ) : (), |
6785b14e |
137 | }; |
138 | } |
139 | |
6785b14e |
140 | sub view_trigger { |
141 | my $trigger = shift; |
142 | |
143 | return { |
144 | 'order' => scalar $trigger->order, |
145 | 'name' => scalar $trigger->name, |
146 | 'perform_action_when' => scalar $trigger->perform_action_when, |
758106cc |
147 | 'database_events' => scalar $trigger->database_events, |
6785b14e |
148 | 'fields' => scalar $trigger->fields, |
149 | 'on_table' => scalar $trigger->on_table, |
150 | 'action' => scalar $trigger->action, |
4384692a |
151 | (defined $trigger->scope ? ( |
152 | 'scope' => scalar $trigger->scope, |
153 | ) : ()), |
00db1ad5 |
154 | keys %{$trigger->extra} ? ('extra' => { $trigger->extra } ) : (), |
6785b14e |
155 | }; |
156 | } |
157 | |
6785b14e |
158 | sub view_view { |
159 | my $view = shift; |
160 | |
161 | return { |
162 | 'order' => scalar $view->order, |
163 | 'name' => scalar $view->name, |
164 | 'sql' => scalar $view->sql, |
165 | 'fields' => scalar $view->fields, |
00db1ad5 |
166 | keys %{$view->extra} ? ('extra' => { $view->extra } ) : (), |
6785b14e |
167 | }; |
168 | } |
169 | |
c16f976a |
170 | sub view_index { |
171 | my $index = shift; |
172 | |
173 | return { |
174 | 'name' => scalar $index->name, |
175 | 'type' => scalar $index->type, |
176 | 'fields' => scalar $index->fields, |
177 | 'options' => scalar $index->options, |
00db1ad5 |
178 | keys %{$index->extra} ? ('extra' => { $index->extra } ) : (), |
c16f976a |
179 | }; |
180 | } |
181 | |
af53e4ec |
182 | 1; |
d3fad399 |
183 | |
75c75c55 |
184 | =head1 SEE ALSO |
185 | |
186 | SQL::Translator, YAML, http://www.yaml.org/. |
6785b14e |
187 | |
188 | =head1 AUTHORS |
189 | |
190 | darren chamberlain E<lt>darren@cpan.orgE<gt>, |
f997b9ab |
191 | Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>. |
6785b14e |
192 | |
193 | =cut |