sql/base/base.sql

   1 --------------------------------------------------------------------------
   2 -- An example of how to use:
   3 --
   4 -- DROP SCHEMA foo CASCADE; CREATE SCHEMA foo;
   5 -- \i base.sql
   6 -- SELECT migration_tools.init('foo');
   7 -- SELECT migration_tools.build('foo');
   8 -- SELECT * FROM foo.fields_requiring_mapping;
   9 -- \d foo.actor_usr
  10 -- create some incoming ILS specific staging tables, like CREATE foo.legacy_items ( l_barcode TEXT, .. ) INHERITS foo.asset_copy;
  11 -- Do some mapping, like UPDATE foo.legacy_items SET barcode = TRIM(BOTH ' ' FROM l_barcode);
  12 -- Then, to move into production, do: select migration_tools.insert_base_into_production('foo')
  13
  14 CREATE SCHEMA migration_tools;
  15
  16 CREATE OR REPLACE FUNCTION migration_tools.production_tables (TEXT) RETURNS TEXT[] AS $$
  17     DECLARE
  18         migration_schema ALIAS FOR $1;
  19         output  RECORD;
  20     BEGIN
  21         FOR output IN
  22             EXECUTE 'SELECT string_to_array(value,'','') AS tables FROM ' || migration_schema || '.config WHERE key = ''production_tables'';'
  23         LOOP
  24             RETURN output.tables;
  25         END LOOP;
  26     END;
  27 $$ LANGUAGE PLPGSQL STRICT STABLE;
  28
  29 CREATE OR REPLACE FUNCTION migration_tools.country_code (TEXT) RETURNS TEXT AS $$
  30     DECLARE
  31         migration_schema ALIAS FOR $1;
  32         output TEXT;
  33     BEGIN
  34         FOR output IN
  35             EXECUTE 'SELECT value FROM ' || migration_schema || '.config WHERE key = ''country_code'';'
  36         LOOP
  37             RETURN output;
  38         END LOOP;
  39     END;
  40 $$ LANGUAGE PLPGSQL STRICT STABLE;
  41
  42
  43 CREATE OR REPLACE FUNCTION migration_tools.log (TEXT,TEXT,INTEGER) RETURNS VOID AS $$
  44     DECLARE
  45         migration_schema ALIAS FOR $1;
  46         sql ALIAS FOR $2;
  47         nrows ALIAS FOR $3;
  48     BEGIN
  49         EXECUTE 'INSERT INTO ' || migration_schema || '.sql_log ( sql, row_count ) VALUES ( ' || quote_literal(sql) || ', ' || nrows || ' );';
  50     END;
  51 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
  52
  53 CREATE OR REPLACE FUNCTION migration_tools.exec (TEXT,TEXT) RETURNS VOID AS $$
  54     DECLARE
  55         migration_schema ALIAS FOR $1;
  56         sql ALIAS FOR $2;
  57         nrows INTEGER;
  58     BEGIN
  59         EXECUTE 'UPDATE ' || migration_schema || '.sql_current SET sql = ' || quote_literal(sql) || ';';
  60         EXECUTE sql;
  61         GET DIAGNOSTICS nrows = ROW_COUNT;
  62         PERFORM migration_tools.log(migration_schema,sql,nrows);
  63     EXCEPTION
  64         WHEN OTHERS THEN
  65             RAISE EXCEPTION '!!!!!!!!!!! state = %, msg = %, sql = %', SQLSTATE, SQLERRM, sql;
  66     END;
  67 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
  68
  69 CREATE OR REPLACE FUNCTION migration_tools.debug_exec (TEXT,TEXT) RETURNS VOID AS $$
  70     DECLARE
  71         migration_schema ALIAS FOR $1;
  72         sql ALIAS FOR $2;
  73         nrows INTEGER;
  74     BEGIN
  75         EXECUTE 'UPDATE ' || migration_schema || '.sql_current SET sql = ' || quote_literal(sql) || ';';
  76         RAISE INFO 'debug_exec sql = %', sql;
  77         EXECUTE sql;
  78         GET DIAGNOSTICS nrows = ROW_COUNT;
  79         PERFORM migration_tools.log(migration_schema,sql,nrows);
  80     EXCEPTION
  81         WHEN OTHERS THEN
  82             RAISE EXCEPTION '!!!!!!!!!!! state = %, msg = %, sql = %', SQLSTATE, SQLERRM, sql;
  83     END;
  84 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
  85
  86 CREATE OR REPLACE FUNCTION migration_tools.init (TEXT) RETURNS VOID AS $$
  87     DECLARE
  88         migration_schema ALIAS FOR $1;
  89         sql TEXT;
  90     BEGIN
  91         EXECUTE 'DROP TABLE IF EXISTS ' || migration_schema || '.sql_current;';
  92         EXECUTE 'CREATE TABLE ' || migration_schema || '.sql_current ( sql TEXT);';
  93         EXECUTE 'INSERT INTO ' || migration_schema || '.sql_current ( sql ) VALUES ( '''' );';
  94         BEGIN
  95             SELECT 'CREATE TABLE ' || migration_schema || '.sql_log ( time TIMESTAMP NOT NULL DEFAULT NOW(), row_count INTEGER, sql TEXT );' INTO STRICT sql;
  96             EXECUTE sql;
  97         EXCEPTION
  98             WHEN OTHERS THEN
  99                 RAISE INFO '!!!!!!!!!!! state = %, msg = %, sql = %', SQLSTATE, SQLERRM, sql;
 100         END;
 101         PERFORM migration_tools.exec( $1, 'DROP TABLE IF EXISTS ' || migration_schema || '.config;' );
 102         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || '.config ( key TEXT UNIQUE, value TEXT);' );
 103         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''production_tables'', ''asset.call_number,asset.copy_location,asset.copy,asset.stat_cat,asset.stat_cat_entry,asset.stat_cat_entry_copy_map,asset.copy_note,actor.usr,actor.card,actor.usr_address,actor.stat_cat,actor.stat_cat_entry,actor.stat_cat_entry_usr_map,actor.usr_note,action.circulation,action.hold_request,money.grocery,money.billing,money.cash_payment,money.forgive_payment'' );' );
 104         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''country_code'', ''USA'' );' );
 105         PERFORM migration_tools.exec( $1, 'DROP TABLE IF EXISTS ' || migration_schema || '.fields_requiring_mapping;' );
 106         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || '.fields_requiring_mapping( table_schema TEXT, table_name TEXT, column_name TEXT, data_type TEXT);' );
 107         BEGIN
 108             PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''last_init'', now() );' );
 109         EXCEPTION
 110             WHEN OTHERS THEN PERFORM migration_tools.exec( $1, 'UPDATE ' || migration_schema || '.config SET value = now() WHERE key = ''last_init'';' );
 111         END;
 112     END;
 113 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 114
 115 CREATE OR REPLACE FUNCTION migration_tools.build (TEXT) RETURNS VOID AS $$
 116     DECLARE
 117         migration_schema ALIAS FOR $1;
 118         production_tables TEXT[];
 119     BEGIN
 120         --RAISE INFO 'In migration_tools.build(%)', migration_schema;
 121         SELECT migration_tools.production_tables(migration_schema) INTO STRICT production_tables;
 122         PERFORM migration_tools.build_base_staging_tables(migration_schema,production_tables);
 123         PERFORM migration_tools.exec( $1, 'CREATE UNIQUE INDEX ' || migration_schema || '_patron_barcode_key ON ' || migration_schema || '.actor_card ( barcode );' );
 124         PERFORM migration_tools.exec( $1, 'CREATE UNIQUE INDEX ' || migration_schema || '_patron_usrname_key ON ' || migration_schema || '.actor_usr ( usrname );' );
 125         PERFORM migration_tools.exec( $1, 'CREATE UNIQUE INDEX ' || migration_schema || '_copy_barcode_key ON ' || migration_schema || '.asset_copy ( barcode );' );
 126         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_callnum_record_idx ON ' || migration_schema || '.asset_call_number ( record );' );
 127         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_callnum_upper_label_id_lib_idx ON ' || migration_schema || '.asset_call_number ( UPPER(label),id,owning_lib );' );
 128         PERFORM migration_tools.exec( $1, 'CREATE UNIQUE INDEX ' || migration_schema || '_callnum_label_once_per_lib ON ' || migration_schema || '.asset_call_number ( record,owning_lib,label );' );
 129     END;
 130 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 131
 132 CREATE OR REPLACE FUNCTION migration_tools.build_base_staging_tables (TEXT,TEXT[]) RETURNS VOID AS $$
 133     DECLARE
 134         migration_schema ALIAS FOR $1;
 135         production_tables ALIAS FOR $2;
 136     BEGIN
 137         --RAISE INFO 'In migration_tools.build_base_staging_tables(%,%)', migration_schema, production_tables;
 138         FOR i IN array_lower(production_tables,1) .. array_upper(production_tables,1) LOOP
 139             PERFORM migration_tools.build_specific_base_staging_table(migration_schema,production_tables[i]);
 140         END LOOP;
 141     END;
 142 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 143
 144 CREATE OR REPLACE FUNCTION migration_tools.build_specific_base_staging_table (TEXT,TEXT) RETURNS VOID AS $$
 145     DECLARE
 146         migration_schema ALIAS FOR $1;
 147         production_table ALIAS FOR $2;
 148         base_staging_table TEXT;
 149         columns RECORD;
 150     BEGIN
 151         base_staging_table = REPLACE( production_table, '.', '_' );
 152         --RAISE INFO 'In migration_tools.build_specific_base_staging_table(%,%) -> %', migration_schema, production_table, base_staging_table;
 153         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || '.' || base_staging_table || ' ( LIKE ' || production_table || ' INCLUDING DEFAULTS EXCLUDING CONSTRAINTS );' );
 154         PERFORM migration_tools.exec( $1, '
 155             INSERT INTO ' || migration_schema || '.fields_requiring_mapping
 156                 SELECT table_schema, table_name, column_name, data_type
 157                 FROM information_schema.columns
 158                 WHERE table_schema = ''' || migration_schema || ''' AND table_name = ''' || base_staging_table || ''' AND is_nullable = ''NO'' AND column_default IS NULL;
 159         ' );
 160         FOR columns IN
 161             SELECT table_schema, table_name, column_name, data_type
 162             FROM information_schema.columns
 163             WHERE table_schema = migration_schema AND table_name = base_staging_table AND is_nullable = 'NO' AND column_default IS NULL
 164         LOOP
 165             PERFORM migration_tools.exec( $1, 'ALTER TABLE ' || columns.table_schema || '.' || columns.table_name || ' ALTER COLUMN ' || columns.column_name || ' DROP NOT NULL;' );
 166         END LOOP;
 167     END;
 168 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 169
 170 CREATE OR REPLACE FUNCTION migration_tools.insert_base_into_production (TEXT) RETURNS VOID AS $$
 171     DECLARE
 172         migration_schema ALIAS FOR $1;
 173         production_tables TEXT[];
 174     BEGIN
 175         --RAISE INFO 'In migration_tools.insert_into_production(%)', migration_schema;
 176         SELECT migration_tools.production_tables(migration_schema) INTO STRICT production_tables;
 177         FOR i IN array_lower(production_tables,1) .. array_upper(production_tables,1) LOOP
 178             PERFORM migration_tools.insert_into_production(migration_schema,production_tables[i]);
 179         END LOOP;
 180     END;
 181 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 182
 183 CREATE OR REPLACE FUNCTION migration_tools.insert_into_production (TEXT,TEXT) RETURNS VOID AS $$
 184     DECLARE
 185         migration_schema ALIAS FOR $1;
 186         production_table ALIAS FOR $2;
 187         base_staging_table TEXT;
 188         columns RECORD;
 189     BEGIN
 190         base_staging_table = REPLACE( production_table, '.', '_' );
 191         --RAISE INFO 'In migration_tools.insert_into_production(%,%) -> %', migration_schema, production_table, base_staging_table;
 192         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || production_table || ' SELECT * FROM ' || migration_schema || '.' || base_staging_table || ';' );
 193     END;
 194 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 195
 196 CREATE OR REPLACE FUNCTION migration_tools.address_parse_out_citystatezip (TEXT) RETURNS TEXT[] AS $$
 197     DECLARE
 198         city_state_zip TEXT := $1;
 199         city TEXT := '';
 200         state TEXT := '';
 201         zip TEXT := '';
 202     BEGIN
 203         zip := CASE WHEN city_state_zip ~ E'\\d\\d\\d\\d\\d' THEN REGEXP_REPLACE( city_state_zip, E'^.*(\\d\\d\\d\\d\\d-?\\d*).*$', E'\\1' ) ELSE '' END;
 204         city_state_zip := REGEXP_REPLACE( city_state_zip, E'^(.*)\\d\\d\\d\\d\\d-?\\d*(.*)$', E'\\1\\2');
 205         IF city_state_zip ~ ',' THEN
 206             state := REGEXP_REPLACE( city_state_zip, E'^(.*),(.*)$', E'\\2');
 207             city := REGEXP_REPLACE( city_state_zip, E'^(.*),(.*)$', E'\\1');
 208         ELSE
 209             IF city_state_zip ~ E'\\s+[A-Z][A-Z]\\s*' THEN
 210                 state := REGEXP_REPLACE( city_state_zip, E'^.*,?\\s+([A-Z][A-Z])\\s*.*$', E'\\1' );
 211                 city := REGEXP_REPLACE( city_state_zip, E'^(.*?),?\\s+[A-Z][A-Z](\\s*.*)$', E'\\1\\2' );
 212             ELSE
 213                 IF city_state_zip ~ E'^\\S+$'  THEN
 214                     city := city_state_zip;
 215                     state := 'N/A';
 216                 ELSE
 217                     state := REGEXP_REPLACE( city_state_zip, E'^(.*?),?\\s*(\\S+)\\s*$', E'\\2');
 218                     city := REGEXP_REPLACE( city_state_zip, E'^(.*?),?\\s*(\\S+)\\s*$', E'\\1');
 219                 END IF;
 220             END IF;
 221         END IF;
 222         RETURN ARRAY[ TRIM(BOTH ' ' FROM city), TRIM(BOTH ' ' FROM state), TRIM(BOTH ' ' FROM zip) ];
 223     END;
 224 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 225
 226 CREATE OR REPLACE FUNCTION migration_tools.rebarcode (o TEXT, t BIGINT) RETURNS TEXT AS $$
 227     DECLARE
 228         n TEXT := o;
 229     BEGIN
 230         IF o ~ E'^\\d+$' AND o !~ E'^0' AND length(o) < 19 THEN -- for reference, the max value for a bigint is 9223372036854775807.  May also want to consider the case where folks want to add prefixes to non-numeric barcodes
 231             IF o::BIGINT < t THEN
 232                 n = o::BIGINT + t;
 233             END IF;
 234         END IF;
 235
 236         RETURN n;
 237     END;
 238 $$ LANGUAGE PLPGSQL STRICT IMMUTABLE;
 239