Open-ILS/src/sql/Pg/upgrade/0526.schema.upgrade-dep-tracking.sql

   1 BEGIN;
   2
   3 INSERT INTO config.upgrade_log (version) VALUES ('0526'); --miker
   4
   5 CREATE TABLE config.db_patch_dependencies (
   6   db_patch      TEXT PRIMARY KEY,
   7   supersedes    TEXT[],
   8   deprecates    TEXT[]
   9 );
  10
  11 CREATE OR REPLACE FUNCTION evergreen.array_overlap_check (/* field */) RETURNS TRIGGER AS $$
  12 DECLARE
  13     fld     TEXT;
  14     cnt     INT;
  15 BEGIN
  16     fld := TG_ARGV[1];
  17     EXECUTE 'SELECT COUNT(*) FROM '|| TG_TABLE_SCHEMA ||'.'|| TG_TABLE_NAME ||' WHERE '|| fld ||' && ($1).'|| fld INTO cnt USING NEW;
  18     IF cnt > 0 THEN
  19         RAISE EXCEPTION 'Cannot insert duplicate array into field % of table %', fld, TG_TABLE_SCHEMA ||'.'|| TG_TABLE_NAME;
  20     END IF;
  21     RETURN NEW;
  22 END;
  23 $$ LANGUAGE PLPGSQL;
  24
  25 CREATE TRIGGER no_overlapping_sups
  26     BEFORE INSERT OR UPDATE ON config.db_patch_dependencies
  27     FOR EACH ROW EXECUTE PROCEDURE evergreen.array_overlap_check ('supersedes');
  28
  29 CREATE TRIGGER no_overlapping_deps
  30     BEFORE INSERT OR UPDATE ON config.db_patch_dependencies
  31     FOR EACH ROW EXECUTE PROCEDURE evergreen.array_overlap_check ('deprecates');
  32
  33 ALTER TABLE config.upgrade_log
  34     ADD COLUMN applied_to TEXT;
  35
  36 CREATE TYPE evergreen_patch AS (patch TEXT);
  37
  38 -- List applied db patches that are deprecated by (and block the application of) my_db_patch
  39 CREATE OR REPLACE FUNCTION evergreen.upgrade_list_applied_deprecates ( my_db_patch TEXT ) RETURNS SETOF evergreen_patch AS $$
  40     SELECT  DISTINCT l.version
  41       FROM  config.upgrade_log l
  42             JOIN config.db_patch_dependencies d ON (l.version::TEXT[] && d.deprecates)
  43       WHERE d.db_patch = $1
  44 $$ LANGUAGE SQL;
  45
  46 -- List applied db patches that are superseded by (and block the application of) my_db_patch
  47 CREATE OR REPLACE FUNCTION evergreen.upgrade_list_applied_supersedes ( my_db_patch TEXT ) RETURNS SETOF evergreen_patch AS $$
  48     SELECT  DISTINCT l.version
  49       FROM  config.upgrade_log l
  50             JOIN config.db_patch_dependencies d ON (l.version::TEXT[] && d.supersedes)
  51       WHERE d.db_patch = $1
  52 $$ LANGUAGE SQL;
  53
  54 -- List applied db patches that deprecates (and block the application of) my_db_patch
  55 CREATE OR REPLACE FUNCTION evergreen.upgrade_list_applied_deprecated ( my_db_patch TEXT ) RETURNS TEXT AS $$
  56     SELECT  db_patch
  57       FROM  config.db_patch_dependencies
  58       WHERE ARRAY[$1]::TEXT[] && deprecates
  59 $$ LANGUAGE SQL;
  60
  61 -- List applied db patches that supersedes (and block the application of) my_db_patch
  62 CREATE OR REPLACE FUNCTION evergreen.upgrade_list_applied_superseded ( my_db_patch TEXT ) RETURNS TEXT AS $$
  63     SELECT  db_patch
  64       FROM  config.db_patch_dependencies
  65       WHERE ARRAY[$1]::TEXT[] && supersedes
  66 $$ LANGUAGE SQL;
  67
  68 -- Make sure that no deprecated or superseded db patches are currently applied
  69 CREATE OR REPLACE FUNCTION evergreen.upgrade_verify_no_dep_conflicts ( my_db_patch TEXT ) RETURNS BOOL AS $$
  70     SELECT  COUNT(*) = 0
  71       FROM  (SELECT * FROM evergreen.upgrade_list_applied_deprecates( $1 )
  72                 UNION
  73              SELECT * FROM evergreen.upgrade_list_applied_supersedes( $1 )
  74                 UNION
  75              SELECT * FROM evergreen.upgrade_list_applied_deprecated( $1 )
  76                 UNION
  77              SELECT * FROM evergreen.upgrade_list_applied_superseded( $1 ))x
  78 $$ LANGUAGE SQL;
  79
  80 -- Raise an exception if there are, in fact, dep/sup confilct
  81 CREATE OR REPLACE FUNCTION evergreen.upgrade_deps_block_check ( my_db_patch TEXT, my_applied_to TEXT ) RETURNS BOOL AS $$
  82 DECLARE
  83     deprecates TEXT;
  84     supersedes TEXT;
  85 BEGIN
  86     IF NOT evergreen.upgrade_verify_no_dep_conflicts( my_db_patch ) THEN
  87         SELECT  STRING_AGG(patch, ', ') INTO deprecates FROM evergreen.upgrade_list_applied_deprecates(my_db_patch);
  88         SELECT  STRING_AGG(patch, ', ') INTO supersedes FROM evergreen.upgrade_list_applied_supersedes(my_db_patch);
  89         RAISE EXCEPTION '
  90 Upgrade script % can not be applied:
  91   applied deprecated scripts %
  92   applied superseded scripts %
  93   deprecated by %
  94   superseded by %',
  95             my_db_patch,
  96             deprecates,
  97             supersedes,
  98             evergreen.upgrade_list_applied_deprecated(my_db_patch),
  99             evergreen.upgrade_list_applied_superseded(my_db_patch);
 100     END IF;
 101
 102     INSERT INTO config.upgrade_log (version, applied_to) VALUES (my_db_patch, my_applied_to);
 103     RETURN TRUE;
 104 END;
 105 $$ LANGUAGE PLPGSQL;
 106
 107 COMMIT;