3 # Copyright (C) 2011 Equinox Software, Inc.
4 # Galen Charlton <gmc@esilibrary.com>
6 # Make template for a new DB patch SQL file.
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License
10 # as published by the Free Software Foundation; either version 2
11 # of the License, or (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
29 exit_usage() if $#ARGV == -1;
31 'num=i' => \$db_patch_num,
32 'name=s' => \$patch_name,
33 'from=s' => \$patch_from,
34 'deprecates=i' => \@deprecates,
35 'supersedes=i' => \@supersedes,
38 exit_usage('--num required') unless defined $db_patch_num;
39 exit_usage('--name required') unless defined $patch_name;
41 $patch_from = 'HEAD' unless defined $patch_from;
44 $db_patch_num = sprintf('%-04.4d', $db_patch_num);
45 $_ = sprintf('%-04.4d', $_) foreach @deprecates;
46 $_ = sprintf('%-04.4d', $_) foreach @supersedes;
49 my @existing = glob("upgrade/$db_patch_num.*");
51 print "Error: $db_patch_num is already used by $existing[0]\n";
54 foreach my $dep (@deprecates) {
55 if ($dep gt $db_patch_num) {
56 print "Error: deprecated patch $dep has a higher patch number than $db_patch_num\n";
60 foreach my $sup (@supersedes) {
61 if ($sup gt $db_patch_num) {
62 print "Error: superseded patch $sup has a higher patch number than $db_patch_num\n";
67 my $patch_file_name = "upgrade/$db_patch_num.$patch_name.sql";
68 open OUT, '>', $patch_file_name or die "$): cannot open output file $patch_file_name: $!\n";
71 -- Evergreen DB patch $db_patch_num.$patch_name.sql
73 -- FIXME: insert description of change, if needed
79 if (@deprecates or @supersedes) {
80 my @ins_cols = ('db_patch');
81 my @ins_vals = ("'$db_patch_num'");
83 print OUT "-- Deprecates patch(es): " . join(', ', @deprecates) . "\n";
84 push @ins_cols, 'deprecates';
85 push @ins_vals, "ARRAY[" . join(', ', map { "'$_'" } @deprecates) . "]";
88 print OUT "-- Supersedes patch(es): " . join(', ', @supersedes) . "\n";
89 push @ins_cols, 'supersedes';
90 push @ins_vals, "ARRAY[" . join(', ', map { "'$_'" } @supersedes) . "]";
92 print OUT "INSERT INTO config.db_patch_dependencies (" .
93 join(', ', @ins_cols) .
95 join(', ', @ins_vals) .
99 my $patch_init_contents;
100 $patch_init_contents = `git diff $patch_from -- ./[0-9][0-9][0-9].*.sql | sed -e '/^[^+-]/d' -e '/^\\(--- a\\|+++ b\\)/d' -e 's/^+//'` if ($patch_from ne '');
102 print OUT <<_FOOTER_;
104 -- check whether patch can be applied
105 SELECT evergreen.update_deps_block_check('$db_patch_num', :eg_version);
107 -- FIXME: add/check SQL statements to perform the upgrade
114 print "Created new patch script $patch_file_name -- please go forth and edit.\n";
118 print "$msg\n\n" if defined($msg);
120 usage: $0 --num <patch_num> --name <patch_name> [--deprecates <num1>] [--supersedes <num2>]
122 Make template for a DB patch SQL file.
124 --num DB patch number
125 --name descriptive part of patch filename
126 --deprecates patch(es) deprecated by this update
127 --supersedes patch(es) superseded by this update
128 --from git refspec to compare against