File Coverage

blib/lib/SQL/Translator/Filter/Globals.pm
Criterion Covered Total %
statement 31 32 96.8
branch 5 10 50.0
condition 1 2 50.0
subroutine 3 3 100.0
pod 0 1 0.0
total 40 48 83.3


line stmt bran cond sub pod time code
1             package SQL::Translator::Filter::Globals;
2              
3             =head1 NAME
4              
5             SQL::Translator::Filter::Globals - Add global fields and indices to all tables.
6              
7             =head1 SYNOPSIS
8              
9             # e.g. Add timestamp field to all tables.
10             use SQL::Translator;
11              
12             my $sqlt = SQL::Translator->new(
13             from => 'MySQL',
14             to => 'MySQL',
15             filters => [
16             Globals => {
17             fields => [
18             {
19             name => 'modified'
20             data_type => 'TIMESTAMP'
21             }
22             ],
23             indices => [
24             {
25             fields => 'modifed',
26             },
27             ]
28             constraints => [
29             {
30             }
31             ]
32             },
33             ],
34             ) || die "SQLFairy error : ".SQL::Translator->error;
35             my $sql = $sqlt->translate || die "SQLFairy error : ".$sqlt->error;
36              
37             =cut
38              
39 1     1   7 use strict;
  1         2  
  1         33  
40 1     1   5 use warnings;
  1         2  
  1         459  
41             our $VERSION = '1.62';
42              
43             sub filter {
44 1     1 0 10 my $schema = shift;
45 1         7 my %args = @_;
46 1   50     8 my $global_table = $args{global_table} ||= '_GLOBAL_';
47              
48 1         3 my (@global_fields, @global_indices, @global_constraints);
49 1 50       3 push @global_fields, @{ $args{fields} } if $args{fields};
  1         3  
50 1 50       5 push @global_indices, @{ $args{indices} } if $args{indices};
  1         3  
51 1 50       4 push @global_constraints, @{ $args{constraints} } if $args{constraints};
  0         0  
52              
53             # Pull fields and indices off global table and then remove it.
54 1 50       6 if ( my $gtbl = $schema->get_table( $global_table ) ) {
55              
56 1         24 foreach ( $gtbl->get_fields ) {
57             # We don't copy the order attrib so the added fields should get
58             # pushed on the end of each table.
59 1         21 push @global_fields, {
60             name => $_->name,
61             comments => "".$_->comments,
62             data_type => $_->data_type,
63             default_value => $_->default_value,
64             size => [$_->size],
65             extra => scalar($_->extra),
66             foreign_key_reference => $_->foreign_key_reference,
67             is_auto_increment => $_->is_auto_increment,
68             is_foreign_key => $_->is_foreign_key,
69             is_nullable => $_->is_nullable,
70             is_primary_key => $_->is_primary_key,
71             is_unique => $_->is_unique,
72             is_valid => $_->is_valid,
73             };
74             }
75              
76 1         5 foreach ( $gtbl->get_indices ) {
77 1         28 push @global_indices, {
78             name => $_->name,
79             type => $_->type,
80             fields => [$_->fields],
81             options => [$_->options],
82             extra => scalar($_->extra),
83             };
84             }
85              
86 1         5 foreach ( $gtbl->get_constraints ) {
87 1         29 push @global_constraints, {
88             name => $_->name,
89             fields => [$_->fields],
90             deferrable => $_->deferrable,
91             expression => $_->expression,
92             match_type => $_->match_type,
93             options => [$_->options],
94             on_delete => $_->on_delete,
95             on_update => $_->on_update,
96             reference_fields => [$_->reference_fields],
97             reference_table => $_->reference_table,
98             table => $_->table,
99             type => $_->type,
100             extra => scalar($_->extra),
101             };
102             }
103              
104 1         6 $schema->drop_table($gtbl);
105             }
106              
107             # Add globals to tables
108 1         6 foreach my $tbl ( $schema->get_tables ) {
109              
110 1         4 foreach my $new_fld ( @global_fields ) {
111             # Don't add if field already there
112 2 50       7 next if $tbl->get_field( $new_fld->{name} );
113 2         12 $tbl->add_field( %$new_fld );
114             }
115              
116 1         5 foreach my $new_index ( @global_indices ) {
117 2         40 $tbl->add_index( %$new_index );
118             }
119              
120 1         4 foreach my $new_constraint ( @global_constraints ) {
121 1         8 $tbl->add_constraint( %$new_constraint );
122             }
123             }
124             }
125              
126             1;
127              
128             __END__